Viewing Menu Details

2025-03-31: THIS INFORMATION IS FOR LEGACY GET CALLS ONLY. THIS PAGE WILL BE UPDATED AT LATER DATE, STRUCTURED SIMILARLY TO "MENU CREATE"

This call allows you to use the menuID obtained from the Menus call to pull information on a single, specific Menu.

This call only shows live current and future menus. Past menus will not show.

Intercom callout — info

Adding External IDs

ezCater’s API Support team will add your menu’s External IDs/PLUs to the ezCater menu for use in querying. The team will export your menu; you will fill in the PLUs for your menu items; and the team will import the information back into the ezCater menu. To initiate this process, contact [email protected]

Query

Query

query Menu($catererId: UUID!, $menuId: UUID) {
  menu(catererId: $catererId, id: $menuId) {
    categories {
      description
      id
      items {
        id
        name
        noteToCaterer
        originalItemId
        sizes {
          customizationTypes {
            id
            name
            originalCustomizationTypeId
            selectionRangeEnd
            selectionRangeStart
            values {
              description
              id
              name
              originalCustomizationValueId
            }
          }
          id
          name
          originalItemSizeId
          serves
          status
        }
      }
      name
      originalCategoryId
    }
    endDate
    id
    name
    startDate
    tablewareItems {
      id
      name
      originalTablewareItemId
    }
  }
}

Variables

Variables

{
  "catererId": null,
  "menuId": null
}

Resources

Arguments

Argument Name	Description
`catererId`: UUID
`id`: UUID

Types

ComboComponent

A grouping of menu items in this menu package

Field Name	Description
constituentItems: [Item!]!	Individual menu items to be selected by the user as part of this package
name: String	Label for this grouping of menu items
servingsPerConstituentItem: Int	Number of people served for each unit of these items

CustomizationType

A label for a grouping of customizations a customer can make on an item. For example, on a salad that offers more than one type of dressing, this would represent the possible dressings

Field Name	Description
id: UUID!
name: String!
originalCustomizationTypeId: UUID	UUID for the customization type this is copied from. Present only if the customization type is a copy.
selectionRangeEnd: Int	Indicates the maximum number of selections a customer can make for any particular customization. An null value indicates that unlimited selections are permitted.
selectionRangeStart: Int	The minimum number of selections a customer must make for this customization.
values: [CustomizationValue!]!

CustomizationValue

A specific selection the customer can make within a given category of customizations. For example, within a 'dressing' CustomizationType, a possible CustomizationValue could be 'ranch' or 'blue cheese'.

Field Name	Description
description: String
id: UUID!
name: String!
originalCustomizationValueId: UUID	UUID for the customization value this is copied from. Present only if the customization value is a copy.
status: CustomizationValueStatus! @deprecated(reason: "This field is not available on this model.")

Item

An item for sale on a particular menu.

Field Name	Description
comboComponents: [ComboComponent!] @deprecated(reason: "This field is not available on this model.")	Constituent menu items for this item
id: UUID!
name: String
noteToCaterer: String	A note written by ezCater's Menus Team to describe what's included in the item. Only visible to the caterer.
originalItemId: UUID	UUID for the item this is copied from. Present only if the item is a copy.
sizes: [ItemSize!]!
status: ItemStatus! @deprecated(reason: "This field is not available on this model.")

ItemSize

A size available for an item.

Field Name	Description
customizationTypes: [CustomizationType!]!
id: UUID!
name: String
originalItemSizeId: UUID	UUID for the item size this is copied from. Present only if the item size is a copy.
serves: Int	How many people this size serves.
status: ItemSizeStatus!

MenuBase

Basic data about a caterer's menu.

Field Name	Description
endDate: Date	The last day that this menu is active.
id: UUID!
name: String!
startDate: Date!	The first day that this menu is active.

MenuBaseConnection

The connection type for MenuBase.

Field Name	Description
edges: [MenuBaseEdge]	A list of edges.
nodes: [MenuBase]	A list of nodes.
pageInfo: PageInfo!	Information to aid in pagination.

MenuBaseEdge

An edge in a connection.

Field Name	Description
cursor: String!	A cursor for use in pagination.
node: MenuBase	The item at the end of the edge.

PageInfo

Information about pagination in a connection.

Field Name	Description
endCursor: String	When paginating forwards, the cursor to continue.
hasNextPage: Boolean!	When paginating forwards, are there more items?
hasPreviousPage: Boolean!	When paginating backwards, are there more items?
startCursor: String	When paginating backwards, the cursor to continue.

TablewareItem

A type of tableware.

Field Name	Description
id: UUID!
name: String!
originalTablewareItemId: UUID	UUID for the tableware item this is copied from. Present only if the tableware item is a copy.

Enums

CustomizationValueStatus

Enum Name	Description
HIDDEN
OUT_OF_SEASON
OUT_OF_STOCK
SHOW
UNAVAILABLE

ItemSizeStatus

Enum Name	Description
HIDDEN
OUT_OF_SEASON
OUT_OF_STOCK
SHOW
UNAVAILABLE

ItemStatus

Enum Name	Description
ARCHIVED
HIDDEN
OUT_OF_SEASON
OUT_OF_STOCK
SHOW
UNAVAILABLE

Scalars

UUID

Universally unique identifier as defined by RFC 4122

Date

ISO-8601 Date-only string, e.g. 2017-12-14

JSON

Represents untyped JSON

Field Name	Description
categories: [Category!]!	The groupings of items within a menu.
endDate: Date	The last day that this menu is active.
id: UUID!
name: String!
startDate: Date!	The first day that this menu is active.
tablewareItems: [TablewareItem!]!	The tablewares a menu offers across all items.