This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.
This section describes information about each menu item at your restaurant.
Menu
Field |
Description |
Data Type |
---|---|---|
entityType |
The type of the menu component described by this JSON
object. The value for a menu object is
|
String |
name |
A descriptive identifier for the menu. For example,
|
String |
guid |
The unique identifier for the menu, assigned by the Toast POS. |
String |
description |
A written description of the menu. |
String |
groups |
A JSON array of MenuGroup objects. |
JSON array |
idString |
This field is for Toast internal use only. |
String |
orderableOnline |
Indicates whether the menu is available for online
ordering. Valid values are |
Boolean |
orderableOnlineStatus |
Indicates whether the menu is available for online
ordering. Valid values are |
String |
visibility |
Indicates where the menu is displayed and who can see it. Values are:
|
String |
startTime |
The time of day when a time-based menu becomes
available. The value is in milliseconds (for example,
|
Int |
endTime |
The time of day when a time-based menu stops being
available. The value is in milliseconds (for example,
|
Int |
startTimeHHmm |
The time of day when a time-based menu becomes
available. The time is in 24-hour HHmm format (for example,
|
String |
endTimeHHmm |
The time of day when a time-based menu stops being
available. The time is in 24-hour HHmm format (for example,
|
String |
startTimeLocalStandardTime |
The time of day when a time-based menu becomes
available. The value is in milliseconds since the start of the
restaurant's day (the day starts at |
Int |
endTimeLocalStandardTime |
The time of day when a time-based menu stops being
available. The value is in milliseconds since the start of the
restaurant's day (the day starts at |
Int |
startTimeHHmmLocalStandardTime |
The time of day when a time-based menu becomes
available. The time is in 24-hour HHmm format (for example,
|
String |
endTimeHHmmLocalStandardTime |
The time of day when a time-based menu stops being
available. The time is in 24-hour HHmm format (for example,
|
String |
availableAllTimes |
Indicates whether the menu is available at all times
of the day. If the value is |
Boolean |
availableAllDays |
Indicates whether the menu is available each day of the week. |
Boolean |
daysAvailableString |
A JSON array of strings that lists the days of the
week when the menu is available. The days are listed in an
abbreviated format, such as In this example, the menu is available on all days except for Sunday and Saturday: "daysAvailableString": [ "Mon", "Tues", "Wed", "Thurs", "Fri" ] |
JSON array |
daysAvailableBits |
This field is a numeric version of the daysAvailableString field and is for Toast internal use only. |
Int |
imageLink |
A URL to an image located on Amazon S3. For example: https://s3.amazonaws.com/toasttab/restaurants/restaurant-59760/menu/items/5/item-4989_149066.jpg |
String |
MenuGroup
Field |
Description |
Data Type |
---|---|---|
entityType |
The type of the menu component described by this JSON
object. The value for a menu object is
|
String |
name |
A descriptive identifier for the menu group. For
example, |
String |
guid |
The unique identifier for the menu group, assigned by the Toast POS. |
String |
description |
A written description of the menu group. |
String |
subgroups |
An array of other |
JSON array |
items |
An array of MenuItem objects. |
JSON array |
idString |
This field is for Toast internal use only. |
String |
imageLink |
A URL to an image located on Amazon S3. For example: https://s3.amazonaws.com/toasttab/restaurants/restaurant-59760/menu/items/5/item-4989_149066.jpg |
String |
orderableOnline |
Indicates whether the menu group is available for online ordering. |
Boolean |
visibility |
Indicates where the menu group is displayed and who can see it. Values are:
|
String |
MenuItem
Field |
Description |
Data Type |
---|---|---|
entityType |
The type of the menu component described by this JSON
object. The value for a menu item object is
|
String |
name |
A descriptive identifier for the menu item. For
example, |
String |
guid |
The unique identifier for the menu item, assigned by the Toast POS. |
String |
description |
A written description of the menu item. |
String |
sku |
The stock keeping unit (SKU) identifier for the item. |
String |
plu |
The price lookup (PLU) code for the item. |
String |
maxSelections |
This value only applies to items in a MenuOptionGroup object. |
Integer |
price |
The amount of money that the item costs, expressed in U.S. dollars. All currency in Toast is treated the same and uses the dollar symbol $. There is no conversion between currency. |
Currency |
prices |
An array of menu-specific prices for the item. If an item is included in more than one menu, it can have different prices on each menu. For example, if you have a Lunch menu and a Dinner menu, a menu item can belong to both menus and have one price for the Lunch menu and a higher price for the Dinner menu. |
JSON array |
isDefault |
Whether or not the item is selected unless a customer chooses to decline it. |
Boolean |
optionGroups |
An array of MenuOptionGroup objects. |
JSON array |
idString |
This field is for Toast internal use only. |
String |
itemGroupGuid |
The unique identifier of the menu group to which this menu item belongs. |
String |
calories |
The caloric value for this menu item. The value can be any positive or negative integer, or zero. |
Integer |
imageLink |
A URL to an image located on Amazon S3. For example: https://s3.amazonaws.com/toasttab/restaurants/restaurant-59760/menu/items/5/item-4989_149066.jpg |
String |
orderableOnline |
Indicates whether the menu item is available for online ordering. |
Boolean |
visibility |
Indicates where the menu item is displayed and who can see it. Values are:
|
String |
MenuOptionGroup
Field |
Description |
Data Type |
---|---|---|
entityType |
The type of the menu component described by this JSON
object. The value for a menu option group object is
|
String |
name |
A descriptive identifier for the menu option group.
For example, |
String |
guid |
The unique identifier for the menu option group, assigned by the Toast POS. |
String |
minSelections |
The minimum number of options that a customer can
choose from the menu option group. If a server must make a
selection from the menu option group, the value is |
Integer |
maxSelections |
The maximum number of options that a customer can
choose from the menu option group. If a customer can choose an
unlimited number of options from a menu option group, the value is
As an example of a menu option group with a maximum greater than one, assume this configuration: Group: Cheese Items: ( Cheddar, American, Swiss ) maxSelections: 2 minSelections: 1 This means:
|
Integer or null |
pricingMode |
Indicates how the options in the menu option group affect the price of the menu items they are applied to. Values are:
|
String |
pricingStrategy |
Indicates the way prices are set for the options in this menu option group. Values are:
|
String |
pricingStrategyRules |
An object that
contains the pricing rules for the chosen pricingStrategy.
If the pricing strategy is |
JSON object |
defaultOptionsChargePrice |
Indicates whether the prices associated with the menu option group's default options are added to the cost of the menu items they modify. Values are:
|
String |
defaultOptionsSubstitutionPricing |
Indicates whether substitution pricing is enabled for the menu options group. Values are:
There are two scenarios that can occur with substitution pricing:
|
String |
items |
An array of the objects that represent the options in the menu option group. |
JSON array |
idString |
This field is for Toast internal use only. |
String |
visibility |
Indicates where the menu option group is displayed and who can see it. Values are:
|
String |
PricingStrategyRules
Field |
Description |
Data Type |
---|---|---|
basePrice |
Used when the pricingStrategy
is set to "optionGroups": [ { "guid": "7aeae7d5-8891-4fa1-bcbd-647ad1f16c66", "name": "Toppings", ... "pricingStrategy":"BASE_PRICE", "pricingStategyRules": { "basePrice": 1.00 } ... } |
Number |
numberOfLevels |
Used when the pricingStrategy
is set to |
Number |
sequencePrices |
Sets the price for each level defined in the numberOfLevels value. For example: "optionGroups": [ { "guid": "7aeae7d5-8891-4fa1-bcbd-647ad1f16c66", "name": "Toppings", ... "pricingStrategy": "SEQUENCE_PRICE", "pricingStrategyRules": { "numberOfLevels": 3, "sequencePrices": [ 0.50, 0.75, 1.00, ] } ... } |
JSON array |