Information about a menu configured for this restaurant.
availability | object An Important
The orders API does not validate against the availability settings of a menu, meaning it is possible to submit an order for an item on a menu when it is not currently available. For this reason, it is particularly important that you check a menu’s |
description | string An optional short description for this menu. |
guid | string A unique identifier for this menu, assigned by the Toast POS system. |
highResImage | string or null The URL to a high resolution image that has been uploaded for this menu. The image file must be in JPG, PNG, or SVG format. The |
image | string or null (Image) The URL to an image that has been uploaded for this menu entity. This value is null if no image has been specified. |
masterId | integer <int64> (MasterId) This value is deprecated. Instead of An identifier that is used to identify and consolidate menu entities that are versions of each other. |
Array of objects (MenuGroup) >= 0 items An array of the | |
multiLocationId | string (MultiLocationId) An identifier that is used to identify and consolidate menu entities that are versions of each other.
Menu entities can be versioned. Those versions can be assigned to specific restaurant locations, or groups of locations, in a management group. For example, you could have two versions of a burger, one for a Boston location and another for a New York City location. Versioned menu entities share the majority of, but not all of, their data. For example, the Boston version is called the Minuteman Burger and has pickles, while the New York City version is called the Empire Burger and does not. You use the The Toast POS system ensures that once a See Toast identifiers in the Toast Developer Guide for more information on the See Enterprise module overview in the Toast Platform Guide for more information on the enterprise module and versioning. |
name | string A descriptive name for this menu, for example, "Food" or "Drinks". |
posButtonColorDark | string (PosButtonColorDark) The color of the menu entity's button on the Toast POS app, when the app is running in dark mode. When an employee configures a POS button's color, they select a color pairing that consists of two colors, one for light mode and one for dark mode.
The following list shows the possible HEX codes for
|
posButtonColorLight | string (PosButtonColorLight) The color of the menu entity's button on the Toast POS app, when the app is running in light mode. When an employee configures a POS button's color, they select a color pairing that consists of two colors, one for light mode and one for dark mode.
The following list shows the possible HEX codes for
|
{- "name": "string",
- "guid": "string",
- "multiLocationId": "string",
- "masterId": 0,
- "description": "string",
- "posButtonColorLight": "string",
- "posButtonColorDark": "string",
- "highResImage": "string",
- "image": "string",
- "availability": { },
- "menuGroups": [
- {
- "name": "string",
- "guid": "string",
- "multiLocationId": "string",
- "masterId": 0,
- "description": "string",
- "posName": "string",
- "posButtonColorLight": "string",
- "posButtonColorDark": "string",
- "image": "string",
- "itemTags": [
- {
- "name": "string",
- "guid": "string"
}
], - "menuGroups": [
- { }
], - "menuItems": [
- {
- "name": "string",
- "kitchenName": "string",
- "guid": "string",
- "multiLocationId": "string",
- "masterId": 0,
- "description": "string",
- "posName": "string",
- "posButtonColorLight": "string",
- "posButtonColorDark": "string",
- "image": "string",
- "price": 0,
- "pricingStrategy": "BASE_PRICE",
- "pricingRules": [
- {
- "timeSpecificPricingRules": [
- null
], - "sizeSpecificPricingGuid": "string",
- "sizeSequencePricingRules": [
- null
]
}
], - "isDeferred": true,
- "isDiscountable": true,
- "salesCategory": {
- "name": "string",
- "guid": "string"
}, - "taxInfo": [
- "string"
], - "taxInclusion": "TAX_INCLUDED",
- "itemTags": [
- {
- "name": "string",
- "guid": "string"
}
], - "plu": "string",
- "sku": "string",
- "calories": 0,
- "contentAdvisories": {
- "alcohol": {
- "containsAlcohol": "YES"
}
}, - "unitOfMeasure": "NONE",
- "portions": [
- {
- "name": "string",
- "guid": "string",
- "modifierGroupReferences": [
- null
]
}
], - "prepTime": 0,
- "prepStations": [
- "string"
], - "modifierGroupReferences": [
- 0
]
}
]
}
]
}