Toast Menus API is one of 80 APIs that Toast publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Menus. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
2 operations
across 2 paths,
and defines 61 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 3 base URLs: https://toast-api-server/config/v2, https://toast-api-server/authentication/v1, https://toast-api-server/menus/v3.
The identity and technical contract details declared by the specification.
ToastReference
object
A wrapper object with fields that allow reference to a Toast entity by Toast GUID.
2 properties
2 required
Image
object
Information about an image associated with a menu or menu item.
1 property
PreModifier
object
Information about a pre-modifier configured for this restaurant.
11 properties
CatalogProductOption
object
An option for a retail product.
4 properties
Portion
object
A container for the modifier groups that can be applied to a portion of a menu item.
4 properties
SizeSequencePricingRule
object
A multi-use object that defines the pricing rules for modifier options that belong to a modifier group that uses the Size Price, Sequence Price, or Size/Sequen…
3 properties
CatalogProductVariantOption
object
A selected option for a retail product variant.
4 properties
Availability
object
Information about when a menu is available for use.
2 properties
Image_2
stringnull
The URL to an image that has been uploaded for this menu entity. This value is null if no image has been specified.
Height
numbernull
The height of the item or modifier. Use the dimensionUnitOfMeasure value to determine the unit of measurement. The height value is null if no height is specifi…
ItemTag
object
A descriptive term that identifies a characteristic of a menu item or menu group, for example, vegetarian, gluten-free, or alcohol.
2 properties
Length
numbernull
The length of the item or modifier. Use the dimensionUnitOfMeasure value to determine the unit of measurement. The length value is null if no length is specifi…
ModifierGroup
object
Information about a modifier group configured for this restaurant, including an array of modifier options contained in the group.
19 properties
Visibility
array
An array of strings that indicate where this menu entity is visible: POS: The menu entity is visible in the Toast POS app. KIOSK: The menu entity is visible on…
WeightUnitOfMeasure
stringnull
The unit of measure assigned to the weight value. Possible values include: NONE: No unit of measurement is assigned. weightUnitOfMeasure can also be null. NONE…
MenuItem
object
Information about a menu item configured for this restaurant.
42 properties
Alcohol
object
Information about whether this menu item or modifier contains alcohol and may require, or benefit from, additional handling. For example, a delivery partner ma…
1 property
TimeRange
object
Represents a time range for when a menu or a time-specific price is available.
2 properties
Schedule
object
A multi-use object that is used to: Define when a menu is available. Define when a time-specific price is available for a menu item or modifier option. A Sched…
2 properties
ContentAdvisories
object
Information about the contents of this menu item or modifier, for example, whether it contains alcohol.
1 property
MultiLocationId
string
An identifier that is used to identify and consolidate menu entities that are versions of each other. multiLocationId replaces masterId. multiLocationId and ma…
PosButtonColorLight
string
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 selec…
CatalogProductInfo
objectnull
Contains retail catalog product information for a menu item.
2 properties
Weight
numbernull
The weight of the item or modifier. Use the weightUnitOfMeasure value to determine the unit of measurement. Th weight value is null if no weight is specified f…
PricingRules
object
The PricingRules object is a multi-use object that provides pricing rules for: A menu item or modifier option item reference that uses the Time Specific Price…
3 properties
CatalogProductVariant
object
The specific version of the retail product that this menu item represents, defined by a unique combination of option values (for example, a T-Shirt with option…
4 properties
ModifierOption
object
Information about a modifier option configured for this restaurant.
40 properties
CatalogProductOptionValue
object
A value within a catalog product option.
3 properties
Restaurant
object
Information about the restaurant whose menu data has been retrieved.
7 properties
PreModifierGroup
object
Information about a pre-modifier group configured for this restaurant, including an array of pre-modifiers contained in the group.
4 properties
PosName
string
The button label name that appears for this menu entity in the Toast POS app. posName contains an empty string if a posName has not been defined for the menu e…
PosButtonColorDark
string
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…
AllergenItem
object
Reserved for future functionality. Not currently supported for external integrations.
5 properties
GuestCount
numbernull
The number of guests the item or modifier is expected to serve. This value is null if no guest count is specified.
Images
array
An array of strings that contain URLs for images that have been uploaded for this item or modifier. The array is empty if no images have been uploaded. Note: T…
CatalogProduct
object
Retail catalog product information for a menu item.
6 properties
Menu_2
object
Information about a menu configured for this restaurant.
13 properties
SalesCategory
object
A descriptive category, for example, "Food" or "Liquor" that, when applied to the menu items and modifier options in your menu, allow you to view sales data by…
2 properties
TimeSpecificPrice
object
Represents the pricing rules for a menu item that uses a time-specific price.
3 properties
Width
numbernull
The width of the item or modifier. Use the dimensionUnitOfMeasure value to determine the unit of measurement. The width value is null if no width is specified…
ModifierOptionTaxInfo
object
Information about the tax rates and tax behavior of this modifier option. Note: The modifierOptionTaxInfo value always reflects the parent menu item tax rate,…
2 properties
MasterId
integer
This value is deprecated. Instead of masterId, use multiLocationId. An identifier that is used to identify and consolidate menu entities that are versions of e…
DimensionUnitOfMeasure
stringnull
The unit of measure assigned to the length, height, and width values. Possible values include: IN: Inches CM: Centimeters FT: Feet M: Meters MM: Millimeters YD…
MenuGroup
object
Information about a menu group configured for this restaurant, including an array of menu items contained in the group.
13 properties
SequencePrice
object
Defines the size, sequence, or size/sequence prices for modifier options contained in a modifier group that uses the Size Price, Sequence Price, or Size/Sequen…
2 properties
CatalogCustomAttributeValue
object
The value of the custom attribute, with a name (i.e. "Cotton") and an id
2 properties
Image_3
stringnull
The URL to an image that has been uploaded for this menu entity. This value is null if no image has been specified.
ModifierGroup_2
object
Information about a modifier group configured for this restaurant, including an array of modifier options contained in the group.
18 properties
MenuItem_2
object
Information about a menu item configured for this restaurant.
41 properties
Alcohol_2
object
Information about whether this menu item or modifier contains alcohol and may require, or benefit from, additional handling. For example, a delivery partner ma…
1 property
CatalogCustomAttribute
object
A merchant-defined property describing a characteristic of a retail catalog product, represented as a name and one or more values. For example, Material: Cotto…
4 properties
CatalogProductInfo_2
objectnull
Contains retail catalog product information for a menu item.
4 properties
PricingRules_2
object
The PricingRules object is a multi-use object that provides pricing rules for: A menu item or modifier option item reference that uses the Time Specific Price…
3 properties
ModifierOption_2
object
Information about a modifier option configured for this restaurant.
39 properties
Restaurant_2
object
Information about the restaurant whose menu data has been retrieved.
7 properties
Menu_3
object
Information about a menu configured for this restaurant.
11 properties
SalesCategory_2
object
A descriptive category, for example, "Food" or "Liquor" that, when applied to the menu items and modifier options in your menu, allow you to view sales data by…
3 properties
CatalogBrand
objectnull
The brand or manufacturer that produces the catalog product, such as a clothing label or a food and beverage company. Typically present on retail and packaged…
2 properties
MenuGroup_2
object
Information about a menu group configured for this restaurant, including an array of menu items contained in the group.
12 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Toast publishes across the network.