Menu

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.

• groups:
  Array of objects (ExternalReference) >= 0 items

  An array of the MenuGroup objects that are part of this menu.

• guid required:
  string

  The GUID maintained by the Toast POS.

• images:
  Array of objects (Image)

  A collection of images associated with the menu.

• name:
  string

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

• 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"
• unitOfMeasure:
  string

  The unit of measure used to determine the price of items in this menu. For example, $10.00 per gram.

  The default is NONE, which means that the item is not meant to be measured during a sale.

  Values are:

  • NONE - The item is not meant to be measured.
  • LB - Weighed in pounds.
  • OZ - Weighed in ounces.
  • KG - Weighed in kilograms.
  • G - Weighed in grams.
  • GAL - Measured in gallons.
  • L - Measured in liters.
  • ML - Measured in milliliters.
  • FL_OZ - Measured in fluid ounces.
  • M - Measured in meters.
  • CM - Measured in centimeters.
  • FT - Measured in feet.
  • IN - Measured in inches.
  • YD - Measured in yards.

  Enum: "NONE" "LB" "OZ" "KG" "G" "GAL" "L" "ML" "FL_OZ" "M" "CM" "FT" "IN" "YD"
• 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",
  "orderableOnline": "YES",
  "visibility": "ALL",
  "groups": [
    {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    }
  ],
  "images": [
    {
      "url": "string"
    }
  ],
  "unitOfMeasure": "NONE"
}