MenuItem

A wrapper object with fields that allow reference to a Toast entity by Toast GUID or a partner's identifier.

calories
integer

The amount of food energy in the item, expressed in Calorie units. Values can be positive, negative, or zero.

entityType
required
string

The type of object this is.

externalId
string

External identifier string, prefixed by the naming authority.

guid
required
string

The GUID maintained by the Toast POS.

Array of objects (Image)

An array of Image objects that are associated with the MenuItem.

inheritOptionGroups
boolean

True if this menu item inherits MenuOptionGroups from its parent MenuGroup.

inheritUnitOfMeasure
boolean

True if this menu item inherits its unit of measure from its parent MenuGroup.

name
string

The name of the menu item as it appears in the Toast POS.

Array of objects (ExternalReference) >= 0 items

An array of ExternalReference objects containing the identifiers of the MenuOptionGroups that contain modifiers applicable to this item. Does not include those inherited from the parent MenuGroup.

orderableOnline
string

Deprecated. Indicates whether restaurant guests can order from the menu online.

Use the visibility array that the menus API (V2) returns for each menu entity, instead of this orderableOnline value, to determine if the entity should be available for online ordering.

Enum: "YES" "NO"
plu
string

The price look up (PLU) code for the item.

sku
string

The stock keeping unit (SKU) code for the item.

type
string

Specifies whether this item is a special request or other off-menu transaction.

  • NONE - a normal menu item or modifier.
  • OPEN_ITEM - an item that is not on a menu.
  • SPECIAL_REQUEST - a selection that is not an item.
  • PORTION - a division of a menu item used to apply modifiers separately to separate parts of an item. For example, one half of a pizza.
Enum: "NONE" "OPEN_ITEM" "SPECIAL_REQUEST" "PORTION"
unitOfMeasure
string

The unit of measure used to determine the price of the item. The default is NONE. This value is not relevant if inheritUnitOfMeasure is true.

Enum: "NONE" "LB" "OZ" "KG" "G"
visibility
string

Deprecated. Indicates where the menu is displayed and who can see it.

  • ALL: Visible to everyone (servers and customers)
  • POS_ONLY: Only visible to servers
  • NONE: Hidden from everyone

Use the visibility array that the menus API (V2) returns for each menu entity, instead of this visibility value, to determine where the entity should be visible.

Enum: "ALL" "POS_ONLY" "NONE"
{
  • "guid": "string",
  • "entityType": "string",
  • "externalId": "string",
  • "name": "string",
  • "calories": 0,
  • "sku": "string",
  • "plu": "string",
  • "orderableOnline": "YES",
  • "visibility": "ALL",
  • "type": "NONE",
  • "optionGroups": [
    ],
  • "inheritOptionGroups": true,
  • "images": [
    ],
  • "unitOfMeasure": "NONE",
  • "inheritUnitOfMeasure": true
}