MenuGroup

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

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 associated with with the MenuGroup.

inheritOptionGroups
boolean

True if this MenuGroup inherits MenuOptionGroups from its parent MenuGroup.

inheritUnitOfMeasure
boolean

True if this MenuGroup inherits its unit of measure from its parent MenuGroup or (if its parent is null) its parent Menu.

Array of objects (ExternalReference) >= 0 items

An array of ExternalReference objects containing the identifiers of the MenuItems in the menu group.

object (ExternalReference)

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

name
string

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

Array of objects (ExternalReference) >= 0 items

An array of ExternalReference objects containing the identifiers of the child MenuOptionGroups that contain modifiers applicable to the group, its subgroups and its items. Does not include MenuOptionGroups inherited from its 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"
object (ExternalReference)

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

Array of objects (ExternalReference) >= 0 items

An array of ExternalReference objects containing the identifiers of the child MenuGroups in the menu group. Empty if the menu group does not include any child menu groups.

unitOfMeasure
string

The unit of measure used to determine the price of items in this group. 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",
  • "menu": {
    },
  • "orderableOnline": "YES",
  • "visibility": "ALL",
  • "parent": {
    },
  • "items": [
    ],
  • "subgroups": [
    ],
  • "optionGroups": [
    ],
  • "inheritOptionGroups": true,
  • "images": [
    ],
  • "unitOfMeasure": "NONE",
  • "inheritUnitOfMeasure": true
}