{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/toast-tab/refs/heads/main/json-schema/menus-menu-item-schema.json", "title": "MenuItem", "description": "Information about a menu item configured for this restaurant.\n", "type": "object", "properties": { "name": { "description": "A descriptive name for this menu item, for example, \"Caesar Salad\" or \"Turkey Sandwich\".\n\nTo avoid menu ingestion failures, if the `name` value is an empty string or `null`, the menus API updates it to the string `Missing name` in the returned menus data.\n\nNote that, while this solution allows menu ingestion to proceed without failure, it does allow a menu item with the name `Missing name` to appear in a restaurant\u2019s menu, creating potential confusion for guests and employees. Also, the menus API only updates the returned data. It does not update the menu item in the Toast database, meaning the name will still be blank when looking at the menu item in Toast Web.\n\nTo fix the issue in Toast Web, the restaurant must identify the parent menu entity for the menu item or modifier, view its details page in Toast Web, and then locate and fix the item with the blank name.\n", "type": "string", "example": "Example Name" }, "kitchenName": { "type": "string", "description": "The name of the menu item as it appears on kitchen tickets. The `kitchenName` can include both numbers and letters. This value contains an empty string if a kitchen name has not been configured for the menu item.\n", "example": "Example Name" }, "guid": { "description": "A unique identifier for this menu item, assigned by the Toast POS system.\n", "type": "string", "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1" }, "multiLocationId": { "$ref": "#/$defs/MultiLocationId" }, "masterId": { "$ref": "#/$defs/MasterId" }, "description": { "description": "An optional short description of this menu item.\n", "type": "string", "example": "string" }, "posName": { "$ref": "#/$defs/PosName" }, "posButtonColorLight": { "$ref": "#/$defs/PosButtonColorLight" }, "posButtonColorDark": { "$ref": "#/$defs/PosButtonColorDark" }, "image": { "$ref": "#/$defs/Image" }, "visibility": { "$ref": "#/$defs/Visibility" }, "price": { "type": "number", "format": "double", "description": "The price of this menu item.\n\nIn Toast Web, menu items may have prices assigned to them individually, or they may inherit them from a parent menu group. The `price` value reflects the menu item's fully resolved pricing configuration in the following ways:\n\n * For base prices, the `price` value is populated with the specified base price.\n \n * For menu-specific prices, the `price` value is resolved based on the current menu. For example, consider a menu item that is included in both Lunch and Dinner menus and is priced at $10 for the Lunch menu and $12 for the Dinner menu. In the fully resolved JSON returned by the menus API, this menu item would appear twice, once as a child of the Lunch menu with a `price` value of $10, and again as a child of the Dinner menu with a `price` value of $12.\n \n If this same menu item is added to a Breakfast menu but a menu-specific price is not defined for the Breakfast menu, then the `price` value for the instance of the menu item that appears in the Breakfast menu JSON is populated with the base price from the menu-specific price configuration. Menu-specific price configurations include a base price that functions as a default price when a menu-specific price cannot be resolved.\n\n * For location-specific prices, the `price` value is resolved based on the current location. For example, consider a menu item that costs $15 in the Boston location and $20 in the New York location. When you retrieve menu data for the Boston location, this menu item's `price` value is $15. When you retrieve menu data for the New York location, the menu item's `price` value is $20.\n \n * For time-specific prices, the `price` value is populated with the base price that is specified as part of the time-specific price configuration. This base price functions as a default price for the menu item during times of the day when a time-specific price has not been defined. For example, consider a menu item that costs $8 from noon to 2pm and $10 during the rest of the day. The `price` value for this item would be $10. You must use the `pricingStrategy` and `pricingRules` values for this menu item to calculate the price of the item during time periods for which a time-specific price has been defined.\n \n * For size prices, the `price` value is null. You must use this menu item's `pricingStrategy` and `pricingRules` values to calculate the price of the item for different sizes.\n \n * For open prices, the `price` value is null.\n\n \n If the menu item is priced using a price level, the `price` value reflects the pricing strategy used for that price level, using the same logic described above. For example, consider a price level that applies a size price to the menu items it is assigned to. In this scenario, the `price` value is null and you must use the menu item's `pricingStrategy` and `pricingRules` values to calculate the price of the item for different sizes.\n\n For more information on menu item pricing and pricing strategies, see the Menu Pricing section in the Toast Platform Guide.\n", "x-nullable": true, "example": 1.0 }, "pricingStrategy": { "type": "string", "enum": [ "BASE_PRICE", "MENU_SPECIFIC_PRICE", "TIME_SPECIFIC_PRICE", "SIZE_PRICE", "OPEN_PRICE" ], "description": "A string that represents the pricing strategy used for this menu item.\n\nYou use the `pricingStrategy` value, in conjunction with the `pricingRules` value, to calculate the price for a menu item that uses the Time Specific Price or Size Price pricing strategy.\n\nIn Toast Web, menu items may have pricing strategies assigned to them individually, or they may inherit them from a parent menu group. The `pricingStrategy` value indicates the menu item's fully resolved pricing strategy. If the menu item is priced using the:\n * Base Price pricing strategy, then the `pricingStrategy` value is BASE_PRICE.\n * Menu Specific Price pricing strategy, then the `pricingStrategy` value is MENU_SPECIFIC_PRICE.\n * Time Specific Price pricing strategy, then the `pricingStrategy` value is TIME_SPECIFIC_PRICE.\n * Size Price pricing strategy, then the `pricingStrategy` value is SIZE_PRICE.\n * Open Price pricing strategy, then the `pricingStrategy` value is OPEN_PRICE.\n\nIf the menu item is priced using the Location Specific Price pricing strategy, then the `pricingStrategy` value indicates which pricing strategy is used at the current location. For example, consider a menu item that uses a menu-specific price at the Boston location and a base price at the New York location. When you retrieve the menu data for the Boston location, the `pricingStrategy` for the menu item is MENU_SPECIFIC_PRICE. When you retrieve menu data for the New York location, the `pricingStrategy` for the menu item is BASE_PRICE.\n\nIf the menu item is priced using a price level, then the `pricingStrategy` value indicates which pricing strategy is used for that price level. For example, if the \"Draft Beer\" pricing level uses a time-specific price, then the `pricingStrategy` value for a menu item that is assigned the \"Draft Beer\" pricing level is TIME_SPECIFIC_PRICE.\n\nIf the `pricingStrategy` value is BASE_PRICE or MENU_SPECIFIC_PRICE, you can retrieve the menu item's price from its `price` value.\n\nIf the `pricingStrategy` value is TIME_SPECIFIC_PRICE or SIZE_PRICE, you must use the rules provided in _this menu item's_ `pricingRules` value to calculate the price for it.\n", "example": "BASE_PRICE" }, "pricingRules": { "type": "object", "description": "A `PricingRules` object with information about how to calculate the price for this menu item. You use a menu item's `pricingRules` value, in conjunction with its `pricingStrategy` value, to calculate a price for a menu item that uses a size-specific or time-specific price.\n\nThe `pricingRules` object takes different forms depending on the pricing strategy configured for the menu item. Use the `pricingStrategy` value to determine which pricing strategy has been used so that you can properly interpret the data in the `pricingRules` object. For the BASE_PRICE, and MENU_SPECIFIC_PRICE pricing strategies, the `pricingRules` object is null because you can retrieve the price from the `price` value without additional calculation. For the OPEN_PRICE pricing strategy, the `pricingRules` object is also null (the price of an open menu item is specified when it is ordered). For the TIME_SPECIFIC_PRICE and SIZE_PRICE pricing strategies, the `PricingRules` object contains additional values that you use to calculate the menu item's price.\n", "items": { "$ref": "#/$defs/PricingRules" }, "x-nullable": true }, "isDeferred": { "type": "boolean", "description": "Indicates whether this menu item should be considered deferred revenue.\n", "example": true }, "isDiscountable": { "type": "boolean", "description": "Indicates whether this menu item can be discounted.\n\n**_Important_** The orders API _does not validate_ against the `isDiscountable` value. If you submit an order that applies a discount to a menu item whose `isDiscountable` value is FALSE, the orders API will not fail the order but it will set the discount amount on the menu item to $0.00. If you are using the menus API to build an ordering application, be sure to inspect the `isDiscountable` value of the menu items to ensure that your ordering application does not allow an item to be discounted if its `isDiscountable` value is FALSE.\n", "example": true }, "salesCategory": { "$ref": "#/$defs/SalesCategory" }, "taxInfo": { "type": "array", "description": "An array of GUIDs for the tax rates that apply to this menu item.\n\nNote that a menu item's tax rates may get overridden if a modifier option is applied to it and that modifier option is configured so that it overrides its parent menu item's tax rates. See Using taxInfo and modifierOptionTaxInfo to calculate taxes for menu items and modifier options in the Toast Developer Guide for more information. \n \nTo retrieve full configuration data for a tax rate, use the `/taxRates/{guid}` endpoint in the configuration API.\n\n_Important:_ The `taxInfo` value is intended to help you display prices but the `/prices` endpoint of the orders API is the only supported way to determine the prices of orders that you submit to the orders API. See Order prices in the Toast Developer Guide for more information.\n", "items": { "type": "string" } }, "taxInclusion": { "type": "string", "enum": [ "TAX_INCLUDED", "TAX_NOT_INCLUDED", "SMART_TAX" ], "description": "A string that represents the tax inclusion setting for this menu item. Possible values include:\n\n* `TAX_INCLUDED`: The menu item's price includes taxes. You should not display additional tax on top of the menu item price in your ordering UI.\n* `TAX_NOT_INCLUDED`: The menu item's price does not include taxes. You should display tax values alongside the menu item price in your ordering UI.\n* `SMART_TAX`: The menu item is using smart tax, a feature that allows a restaurant to configure menu item prices to include or not include taxes, depending on the section of the restaurant that the item is ordered in (for example, the bar or the dining room). For example, a guest can order an item at either the bar or in the main dining room. To prevent bartenders from having to handle coins, which can slow down service, and to make tipping easier, the restaurant wants the price of the item to be a whole number that includes tax when it is ordered at the bar. In the main dining room, where speed of service is less of a concern, the restaurant doesn't want the item's price to include tax, so that it doesn't lose out on the extra revenue.\n\nTypically, the smart tax setting is used for in-store workflows where the efficiency of money handling is a priority. As such, it doesn't apply to online ordering integrations. If a menu item's `taxInclusion` value is set to `SMART_TAX`, your ordering integration should treat the menu item as if tax is not included. For more information on the smart tax feature, see Smart tax in the Toast Platform Guide.\n\n_Note:_ A menu item's tax inclusion setting is inherited by any modifiers that are applied to that menu item. For more information, see Tax functionality interaction in the Toast Platform Guide.\n", "example": "TAX_INCLUDED" }, "itemTags": { "type": "array", "description": "An array of `ItemTag` objects that are assigned to this menu item. Item tags are used to assign identifying characteristics to a menu item, for example, vegetarian, gluten-free, or alcohol.\n", "items": { "$ref": "#/$defs/ItemTag" } }, "plu": { "type": "string", "description": "The price lookup (PLU) code for this menu item. The PLU code can include both numbers and letters. This value contains an empty string if a PLU code has not been defined.\n", "example": "string" }, "sku": { "type": "string", "description": "The stock keeping unit (SKU) identifier for this menu item. The SKU identifier can include both numbers and letters. This value contains an empty string if a SKU has not been defined.\n", "example": "string" }, "calories": { "type": "integer", "description": "The number of calories in this menu item. The calories value can be any positive or negative integer, or zero. This value is null if a calories amount has not been configured for the menu item.\n", "x-nullable": true, "example": 1 }, "contentAdvisories": { "$ref": "#/$defs/ContentAdvisories" }, "unitOfMeasure": { "type": "string", "enum": [ "NONE", "LB", "OZ", "KG", "G", "GAL", "L", "ML", "FL_OZ", "M", "CM", "FT", "IN", "YD" ], "description": "The unit of measure used to determine the price of the item. For example, $10.00 per gram.\n\nThe default is `NONE`, which means that the item is not meant to be measured during a sale.\n\nValues are:\n* `NONE` - The item is not meant to be measured.\n* `LB` - Weighed in pounds.\n* `OZ` - Weighed in ounces.\n* `KG` - Weighed in kilograms.\n* `G` - Weighed in grams.\n* `GAL` - Measured in gallons.\n* `L` - Measured in liters.\n* `ML` - Measured in milliliters.\n* `FL_OZ` - Measured in fluid ounces.\n* `M` - Measured in meters.\n* `CM` - Measured in centimeters.\n* `FT` - Measured in feet.\n* `IN` - Measured in inches.\n* `YD` - Measured in yards.\n", "example": "NONE" }, "portions": { "type": "array", "description": "An array of `Portion` objects that define the portions that can be used with this menu item. For example, for a pizza menu item, you could define 1st Half and 2nd Half portions. See Portions overview in the Toast Platform Guide for more information on portions.\n", "minItems": 0, "items": { "$ref": "#/$defs/Portion" } }, "prepTime": { "type": "integer", "description": "The amount of time, in seconds, that it takes to prepare this menu item. This value is null if a prep time has not been specified for the menu item.
\n
\n*Related topics*
\nUsing prep times to automate item firing
\n", "format": "int32", "x-nullable": true, "example": 1 }, "prepStations": { "type": "array", "description": "An array of GUIDs for the prep stations that have been assigned to this menu item. This array is empty if no prep stations have been assigned.
\n
\n*Related topics:*
\nRouting to prep stations\n", "items": { "type": "string" } }, "modifierGroupReferences": { "type": "array", "description": "An array of `referenceId`s for `ModifierGroup` objects. These objects define the modifier groups that apply to this menu item.\n", "minItems": 0, "items": { "type": "integer" } }, "eligiblePaymentAssistancePrograms": { "type": "array", "description": "An array of strings that indicate which payment assistance programs may be used to pay for this menu item. Possible values include:\n\n* `SNAP`: Supplemental Nutrition Assistance Program\n* `EBT_CASH`: Electronic Benefit Transfer Cash\n\nThe array is empty if no payment assistance programs have been assigned to the menu item.\n", "items": { "type": "string" } }, "allergens": { "type": "array", "description": "Reserved for future functionality. Not currently supported for external integrations.\n", "minItems": 0, "items": { "$ref": "#/$defs/AllergenItem" }, "x-nullable": true }, "length": { "$ref": "#/$defs/Length" }, "height": { "$ref": "#/$defs/Height" }, "width": { "$ref": "#/$defs/Width" }, "dimensionUnitOfMeasure": { "$ref": "#/$defs/DimensionUnitOfMeasure" }, "weight": { "$ref": "#/$defs/Weight" }, "weightUnitOfMeasure": { "$ref": "#/$defs/WeightUnitOfMeasure" }, "images": { "$ref": "#/$defs/Images" }, "guestCount": { "$ref": "#/$defs/GuestCount" }, "sortOrder": { "type": "integer", "description": "A number determining the order in which this item should appear on kitchen tickets. The sort order value can be any positive or negative integer, or zero. This value is null if a sort order has not been configured for the menu item.\n", "x-nullable": true, "example": 1 }, "catalogProductInfo": { "$ref": "#/$defs/CatalogProductInfo" }, "isComboParent": { "type": "boolean", "description": "Reserved for future functionality. Not currently supported for external integrations.", "x-nullable": true, "example": true } }, "$defs": { "MultiLocationId": { "type": "string", "description": "An identifier that is used to identify and consolidate menu entities that are versions of each other.\n\n`multiLocationId` replaces `masterId`. `multiLocationId` and `masterId` always have the same value.\n\nMenu 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.\n\nYou use the `multiLocationId` to identify menu entities that are versions of each other. To continue the example above, the Minuteman Burger in the JSON returned for the Boston location has the same `multilocationId` as the Empire Burger in the JSON returned for the New York City location. These matching `multlocationId` values indicate that the two items are related versions of the same item. In Toast reports, this allows a restaurant to track sales of the burger across both locations.\n\nThe Toast POS system ensures that once a `multilocationId` value is assigned to a set of versions within a management group, that `multiLocationId` is not used for any other version sets in the same management group. It does not guarantee, however, that the `multiLocationId` is not used by another management group to identify a set of versions within it.\n\nSee Toast identifiers in the Toast Developer Guide for more information on the `multiLocationId` and its relationship to other Toast identifiers.\n\nSee Enterprise module overview in the Toast Platform Guide for more information on the enterprise module and versioning.\n" }, "MasterId": { "type": "integer", "format": "int64", "description": "This value is deprecated. Instead of `masterId`, use `multiLocationId`.\n\nAn identifier that is used to identify and consolidate menu entities that are versions of each other.\n" }, "PosName": { "type": "string", "description": "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 entity and the `name` value is used for the button label instead.\n" }, "PosButtonColorLight": { "type": "string", "description": "The color of the menu entity's button on the Toast POS app, when the app is running in light mode.\n \nWhen 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. `posButtonColorLight` contains the HEX code for the light mode color.\n\n`posButtonColorLight` defaults to `#f7f7f7`, the HEX code when the `WHITE` color pairing is chosen.\n\nThe following list shows the possible HEX codes for `posButtonColorLight`, with the associated color pairing in parentheses.\n\n* #f7f7f7 (WHITE)\n* #ffe6e9 (TERRACOTTA_1)\n* #efa49f (TERRACOTTA_2)\n* #f07166 (TERRACOTTA_3)\n* #e45a4e (TERRACOTTA_4)\n* #fbd9b6 (ORANGE_1)\n* #f7be6e (ORANGE_2)\n* #f98c1f (ORANGE_3)\n* #e56f1a (ORANGE_4) \n* #fbf5b6 (YELLOW_1)\n* #fed850 (YELLOW_2)\n* #e9b10c (YELLOW_3)\n* #c78605 (YELLOW_4) \n* #e8f7d4 (GRASS_1)\n* #afe26c (GRASS_2)\n* #71b314 (GRASS_3)\n* #32a206 (GRASS_4) \n* #e3f0fb (SKY_1)\n* #9fc5f0 (SKY_2)\n* #77a5e4 (SKY_3)\n* #558edd (SKY_4) \n* #f1e3fd (LAVENDER_1)\n* #dab2f7 (LAVENDER_2)\n* #b26ee2 (LAVENDER_3)\n* #a270db (LAVENDER_4) \n* #d0d0d0 (GRAY_1)\n* #c3c3c3 (GRAY_2)\n* #b1b1b1 (GRAY_3)\n* #989898 (GRAY_4)\n" }, "PosButtonColorDark": { "type": "string", "description": "The color of the menu entity's button on the Toast POS app, when the app is running in dark mode.\n \nWhen 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. `posButtonColorDark` contains the HEX code for the dark mode color.\n\n`posButtonColorDark` defaults to `#1a1c23`, the HEX code when the `WHITE` color pairing is chosen.\n\nThe following list shows the possible HEX codes for `posButtonColorDark`, with the associated color pairing in parentheses.\n\n* #1a1c23 (WHITE)\n* #7e635d (TERRACOTTA_1)\n* #74504D (TERRACOTTA_2)\n* #722e25 (TERRACOTTA_3)\n* #561408 (TERRACOTTA_4)\n* #8f5f3d (ORANGE_1)\n* #7e4116 (ORANGE_2)\n* #803500 (ORANGE_3)\n* #682d03 (ORANGE_4) \n* #7e6b44 (YELLOW_1)\n* #7b5f27 (YELLOW_2)\n* #7c5000 (YELLOW_3)\n* #633d09 (YELLOW_4) \n* #657552 (GRASS_1)\n* #556e34 (GRASS_2)\n* #37570a (GRASS_3)\n* #113a00 (GRASS_4) \n* #637486 (SKY_1)\n* #4d6074 (SKY_2)\n* #2a456b (SKY_3)\n* #213554 (SKY_4) \n* #78668a (LAVENDER_1)\n* #5e4776 (LAVENDER_2)\n* #402960 (LAVENDER_3)\n* #25174f (LAVENDER_4) \n* #6c6c6c (GRAY_1)\n* #5f5f5f (GRAY_2)\n* #474747 (GRAY_3)\n* #404040 (GRAY_4)\n" }, "Image": { "type": "string", "description": "The URL to an image that has been uploaded for this menu entity. This value is null if no image has been specified.\n", "x-nullable": true }, "Visibility": { "type": "array", "description": "An array of strings that indicate where this menu entity is visible:\n\n* POS: The menu entity is visible in the Toast POS app. \n\n* KIOSK: The menu entity is visible on a Toast kiosk. \n\n* TOAST_ONLINE_ORDERING: The menu entity is visible in the Toast online\n ordering site for this restaurant. \n\n* ORDERING_PARTNERS: The restaurants wants this menu entity to be visible\n on online ordering sites that integrate with the Toast POS system using the orders API. \n\n* GRUBHUB: Deprecated. The menu entity is included during a menu sync to\n Grubhub and will be visible on the Grubhub online ordering service after a\n menu sync has completed. _Note:_ Conceptually, the _Grubhub_ configuration\n option that was associated with the `GRUBHUB` string in this array has\n been replaced by the more general _Online orders: Ordering partners_\n configuration option and restaurants that used the _Grubhub_ option have\n been automatically migrated to the new _Online orders: Ordering partners_\n option. This means that any menu entity that had the _Grubhub_ option set\n to _Yes_ will now have the _Online orders: Ordering partners_ option\n enabled and the `ORDERING_PARTNERS` enum will be present in the\n `visibility` array for it. To support backwards compatibility, the\n `visibility` array for these entities will also continue to contain the\n `GRUBHUB` enum for a short period of time. See Menu\n Visibility Enhancements (Rolled Out) for more information.\n\nThe `visibility` array is empty if the menu entity is not configured to be visible for any of the use cases listed above.\n", "items": { "type": "string", "enum": [ "POS", "KIOSK", "GRUBHUB", "TOAST_ONLINE_ORDERING", "ORDERING_PARTNERS" ] } }, "PricingRules": { "type": "object", "description": "The PricingRules object is a multi-use object that provides pricing rules for:\n * A menu item or modifier option item reference that uses the Time Specific Price or Size Price pricing strategy.\n * A modifier group that uses the Size Price, Sequence Price, or Size/Sequence Price pricing strategy.\n", "properties": { "timeSpecificPricingRules": { "description": "An array of `TimeSpecificPrice` objects that define the time-specific prices for a menu item or modifier option item reference that uses the Time Specific Price pricing strategy. If the menu item or modifier option item reference does not use time-specific prices, this array is empty.\n", "type": "array", "items": { "$ref": "#/$defs/TimeSpecificPrice" } }, "sizeSpecificPricingGuid": { "description": "The GUID of a Size modifier group that defines sizes and prices for a menu item or a modifier option item reference that uses the Size Price pricing strategy.\n\nIf the menu item or modifier option item reference does not use the Size Price pricing strategy, then `sizeSpecificPricingGuid` is null.\n\nThe Toast POS system automatically creates a Size modifier group when you choose the Size Price pricing strategy for a menu item or modifier option item reference and stores the sizes and prices you specify in it. You use the `sizeSpecificPricingGuid` value to locate the correct Size modifier group to use when pricing a menu item or modifier option item reference that uses size pricing. In the JSON fragment below, you can see that the Cheese Pizza menu item uses the SIZE_PRICE pricing strategy and the Size modifier group where the sizes and prices for Cheese Pizza are defined has a GUID that ends in `31b0`.\n\n```\n{\n \"restaurantGuid\": \"2071fb81-988b-4d75-b8dc-c5c17cff9706\",\n ...\n \"menus\": [\n {\n \"name\": \"Dinner\",\n \"guid\": \"ddd681de-3c12-4d45-b8b1-a5b2ea898210\",\n ...\n \"menuGroups\": [\n {\n \"name\": \"Pizza\",\n \"guid\": \"dc868006-919a-4950-a4cc-3a03f9770fd7\",\n ...\n \"menuItems\": [\n {\n \"name\": \"Cheese Pizza\",\n \"guid\": \"95c5d500-8d92-46f2-bec4-fb2a42a46621\",\n ...\n \"price\": null,\n \"pricingStrategy\": \"SIZE_PRICE\",\n \"pricingRules\": {\n \"timeSpecificPricingRules\": [],\n \"sizeSpecificPricingGuid\": \"23c02762-9d6a-4d3f-a298-71c989bf31b0\",\n \"sizeSequencePricingRules\": []\n },\n ...\n \"modifierGroupReferences\": [\n 2,\n 6,\n ...\n ],\n ...\n }\n ]\n }\n ]\n }\n ],\n \"modifierGroupReferences\": {\n ...\n \"2\": {\n \"referenceId\": 2,\n \"name\": \"Size\",\n \"guid\": \"23c02762-9d6a-4d3f-a298-71c989bf31b0\",\n ...\n \"pricingStrategy\": \"NONE\",\n \"pricingRules\": null,\n ...\n \"modifierOptionReferences\": [\n 12,\n 13\n ],\n ...\n },\n ...\n },\n \"modifierOptionReferences\": {\n ...\n \"12\": {\n \"referenceId\": 12,\n \"name\": \"Small\",\n \"guid\": \"352244f2-a952-4a3a-a3ae-7775fa221ce7\",\n ...\n \"price\": 8.0,\n \"pricingStrategy\": \"BASE_PRICE\",\n \"pricingRules\": null,\n ...\n \"modifierGroupReferences\": []\n },\n \"13\": {\n \"referenceId\": 13,\n \"name\": \"Large\",\n \"guid\": \"4ff89bca-b448-4892-bc4c-62c37a28ac44\",\n ...\n \"price\": 10.0,\n \"pricingStrategy\": \"BASE_PRICE\",\n \"pricingRules\": null,\n ...\n \"modifierGroupReferences\": []\n }\n ...\n }\n}\n```\n\n\nWhen the `PricingRules` object appears in the context of a modifier\ngroup, the `sizeSpecificPricingGuid` value it contains is also used to\nfind matching sizes between menu items and any modifier options that\nuse the Size Price or Size/Sequence Pricing pricing strategies (for\nexample, toppings on a small pizza cost $1 while toppings on a large\npizza cost $2). In this scenario, the Toast POS system locates the\nmodifier option size that matches the menu item size and uses the\nprice defined for that size of the modifier option. The sizes for the\nmenu item are defined in the Size modifier group specified by the\n`sizeSpecificPricingGuid` value. The sizes for the modifier options\nare defined in objects contained in the `sizeSequencePricingRules`\narray that is contained in the modifier group's `PricingRules` object.\nSizes are considered matching when their names are identical. For\ndetailed information on the **Size Price** and **Size/Sequence Price**\npricing strategies, see [Pricing\nStrategies](https://doc.toasttab.com/doc/platformguide/adminPricingStrategies.html)\nin the _Toast Platform Guide_.\n\nIn the example below, the Cheese Pizza menu item and the Toppings\nmodifier group use the `SIZE_PRICE` pricing strategy. The menu item\nsizes and prices are defined in the Size modifier group with a GUID\nending in `31b0`. The sizes and prices for the modifier options are\ndefined in the `sizeSequencePricingRules` value that is a child of the\nToppings modifier group.\n\n```\n{\n \"restaurantGuid\": \"2071fb81-988b-4d75-b8dc-c5c17cff9706\",\n ...\n \"menus\": [\n {\n \"name\": \"Dinner\",\n \"guid\": \"ddd681de-3c12-4d45-b8b1-a5b2ea898210\",\n ...\n \"menuGroups\": [\n {\n \"name\": \"Pizza\",\n \"guid\": \"dc868006-919a-4950-a4cc-3a03f9770fd7\",\n ...\n \"menuItems\": [\n {\n \"name\": \"Cheese Pizza\",\n \"guid\": \"95c5d500-8d92-46f2-bec4-fb2a42a46621\",\n ...\n \"price\": null,\n \"pricingStrategy\": \"SIZE_PRICE\",\n \"pricingRules\": {\n \"timeSpecificPricingRules\": [],\n \"sizeSpecificPricingGuid\": \"23c02762-9d6a-4d3f-a298-71c989bf31b0\",\n \"sizeSequencePricingRules\": []\n },\n ...\n \"modifierGroupReferences\": [\n 2,\n 3,\n ...\n ],\n ...\n }\n ]\n }\n ]\n }\n ],\n \"modifierGroupReferences\": {\n ...\n \"2\": {\n \"referenceId\": 2,\n \"name\": \"Size\",\n \"guid\": \"23c02762-9d6a-4d3f-a298-71c989bf31b0\",\n ...\n \"pricingStrategy\": \"NONE\",\n \"pricingRules\": null,\n ...\n \"modifierOptionReferences\": [\n 12,\n 13\n ],\n ...\n },\n \"3\": {\n \"referenceId\": 3,\n \"name\": \"Toppings\",\n \"guid\": \"58b79986-f88f-411d-ba18-14b1e2441e9d\",\n ...\n \"pricingStrategy\": \"SIZE_PRICE\",\n \"pricingRules\": {\n \"timeSpecificPricingRules\": [],\n \"sizeSpecificPricingGuid\": \"23c02762-9d6a-4d3f-a298-71c989bf31b0\",\n \"sizeSequencePricingRules\": [\n {\n \"sizeName\": \"Small\",\n \"sizeGuid\": \"352244f2-a952-4a3a-a3ae-7775fa221ce7\",\n \"sequencePrices\": [\n {\n \"sequence\": 1,\n \"price\": 2.0\n }\n ]\n },\n {\n \"sizeName\": \"Large\",\n \"sizeGuid\": \"4ff89bca-b448-4892-bc4c-62c37a28ac44\",\n \"sequencePrices\": [\n {\n \"sequence\": 1,\n \"price\": 4.0\n }\n ]\n }\n ]\n },\n ...\n \"modifierOptionReferences\": [\n 10,\n 11\n ],\n ...\n },\n ...\n },\n \"modifierOptionReferences\": {\n ...\n \"10\": {\n \"referenceId\": 10,\n \"name\": \"Mushrooms\",\n \"guid\": \"fa24fee9-76c4-40ba-ae3c-7dfccafdd8d3\",\n ...\n \"price\": null,\n \"pricingStrategy\": \"GROUP_PRICE\",\n \"pricingRules\": null,\n ...\n \"modifierGroupReferences\": []\n },\n \"11\": {\n \"referenceId\": 11,\n \"name\": \"Onions\",\n \"guid\": \"afee6be7-8280-4c69-a170-9fdf4c76bf7b\",\n ...\n \"price\": null,\n \"pricingStrategy\": \"GROUP_PRICE\",\n \"pricingRules\": null,\n ...\n \"modifierGroupReferences\": []\n },\n \"12\": {\n \"referenceId\": 12,\n \"name\": \"Small\",\n \"guid\": \"352244f2-a952-4a3a-a3ae-7775fa221ce7\",\n ...\n \"price\": 8.0,\n \"pricingStrategy\": \"BASE_PRICE\",\n \"pricingRules\": null,\n ...\n \"modifierGroupReferences\": []\n },\n \"13\": {\n \"referenceId\": 13,\n \"name\": \"Large\",\n \"guid\": \"4ff89bca-b448-4892-bc4c-62c37a28ac44\",\n ...\n \"price\": 10.0,\n \"pricingStrategy\": \"BASE_PRICE\",\n \"pricingRules\": null,\n ...\n \"modifierGroupReferences\": []\n },\n ...\n }\n} \n``` \n", "type": "string", "x-nullable": true, "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1" }, "sizeSequencePricingRules": { "type": "array", "description": "An array of `SizeSequencePricingRule` objects that define the prices for the modifier options in a modifier group that uses the Size Price, Sequence Price, or Size/Sequence Pricing pricing strategy. If the modifier group does not use one of these pricing strategies, this array is empty.\n", "items": { "$ref": "#/$defs/SizeSequencePricingRule" } } } }, "TimeSpecificPrice": { "type": "object", "description": "Represents the pricing rules for a menu item that uses a time-specific price.\n", "properties": { "timeSpecificPrice": { "type": "number", "format": "double", "description": "The price of the menu item during the periods of time defined by the associated `schedule` array.\n", "example": 1.0 }, "basePrice": { "type": "number", "format": "double", "description": "The base price of the menu item, used for time periods when a time-specific price has not been defined.\n", "example": 1.0 }, "schedule": { "type": "array", "description": "An array of `Schedule` objects that indicate the specific days and times that a time-specific price is available.\n", "items": { "$ref": "#/$defs/Schedule" } } } }, "Schedule": { "type": "object", "description": "A multi-use object that is used to:\n\n* Define when a menu is available.\n* Define when a time-specific price is available for a menu item or modifier option.\n\nA `Schedule` object defines a set of days of the week and a set of time ranges for those days. Days that have identical time ranges are grouped into a single `Schedule` object, for example, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, and FRIDAY in the example below have identical time ranges and are in the same `Schedule` object while SATURDAY and SUNDAY are in a separate `Schedule` object because their time ranges differ from the weekday time ranges.\n\n```\n\"availability\": {\n \"alwaysAvailable\": false,\n \"schedule\": [\n {\n \"days\": [\n \"MONDAY\", \n \"TUESDAY\", \n \"WEDNESDAY\", \n \"THURSDAY\"\n ],\n \"timeRanges\": [\n {\n \"start\": \"09:00\",\n \"end\": \"18:00\"\n }\n ]\n },\n {\n \"days\": [\n \"FRIDAY\", \n \"SATURDAY\"\n ],\n \"timeRanges\": [\n {\n \"start\": \"09:00\",\n \"end\": \"18:00\"\n },\n {\n \"start\": \"20:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n ]\n}\n```\n\nTime ranges are in 24-hour HH:MM format.\n\nIf a day is not represented in the `Schedule` objects, the menu or time-specific price is not available on that day. \n", "properties": { "days": { "type": "array", "description": "An array of days of the week that are associated with identical time ranges. The time ranges are defined in a corresponding `timeRanges` value. Names of the days are in upper case, for example, MONDAY.\n", "items": { "type": "string", "description": "A day of the week, for example, SUNDAY or THURSDAY.", "enum": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] } }, "timeRanges": { "type": "array", "description": "An array of `TimeRange` objects that define the time ranges that a menu or a time-specific price is available on the days defined by the corresponding `days` value. A `TimeRange` object contains a `start` time and an `end` time, expressed in the restaurant\u2019s local time. If both the `start` and `end` times for a given day are 00:00, it indicates that the menu or the time-specific price is available 24 hours on the associated days. Time ranges may also run overnight, for example, a time range that starts at \"07:00\" and ends at \"03:00\" runs from 7am until 3am the next day. \n", "items": { "$ref": "#/$defs/TimeRange" } } } }, "TimeRange": { "type": "object", "description": "Represents a time range for when a menu or a time-specific price is available.\n", "properties": { "start": { "type": "string", "description": "The start time of the time range. Expressed in the restaurant\u2019s local time.\n", "example": "string" }, "end": { "type": "string", "description": "The end time of the time range. Expressed in the restaurant\u2019s local time.\n", "example": "string" } } }, "SizeSequencePricingRule": { "type": "object", "description": "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/Sequence Price pricing strategy. The contents of this object depend on the pricing strategy that is in effect.\n", "properties": { "sizeName": { "type": "string", "description": "A string that represents the size of a modifier option in this modifier group, for example, Small, Medium, or Large.\n\nWith Size Price and the Size/Sequence Price pricing strategies, the price of a modifier option changes based on the size of the menu item it is applied to, for example, a topping costs $1 on a small pizza and $2 on a large pizza. To determine which size and size-based price to use for a modifier option, the Toast POS system matches the size name of the modifier option to the size name of the menu item. For example, the Small size of a modifier option would match the Small size of a menu item. The `sizeName` value of the `SizeSequencePricingRule` object represents the modifier option size while the `sizeGuid` value represents the matching menu item size.\n\nThe Toast POS system does allow a configuration where the size of the modifier option is specified independently from the size of the menu item it applies to. In this scenario, you could order a Large menu item and apply a Small size of the modifier option to it. This configuration is unusual but the menus API supports it. When this configuration is in use, the `sizeName` value is populated with the modifier option size but the `sizeGuid` value that represents the menu item size will be null because there is no matching menu item size.\n\nThe `sizeName` value is null if the modifier group uses the Sequence Price pricing strategy because this strategy does not use sizes.\n\nSee the Pricing strategies section in the Toast Platform Guide for information on the Size Price, Sequence Price, and Size/Sequence Price pricing strategies.\n", "x-nullable": true, "example": "Example Name" }, "sizeGuid": { "type": "string", "description": "The GUID of the modifier option where a menu item size has been defined that matches the `sizeName` value. For example, if a menu item has Small and Large sizes, those sizes are represented in a Size modifier group with a Small modifier option and a Large modifier option. It is the GUID of one of those size modifier options that appears in this value. If the `sizeName` value is Small, then the `sizeGuid` value would contain the Small modifier option\u2019s GUID.\n\nWith Size Price and the Size/Sequence Price pricing strategies, the price of a modifier option changes based on the size of the menu item it is applied to, for example, a topping costs $1 on a small pizza and $2 on a large pizza. To determine which size and size-based price to use for a modifier option, the Toast POS system matches the size name of the modifier option to the size name of the menu item. For example, the Small size of a modifier option would match the Small size of a menu item. The `sizeName` value represents the modifier option size while the `sizeGuid` value represents the matching menu item size.\n\nThe Toast POS system does allow a configuration where the size of the modifier option is specified independently from the size of the menu item it applies to. In this scenario, you could order a Large menu item and apply a Small size of the modifier option to it. This configuration is unusual but the menus API supports it. When this configuration is in use, the `sizeName` value is populated with the modifier option size but there is no corresponding `sizeGuid` for the menu item size.\n\nThe `sizeGuid` value is null if the modifier group uses the Sequence Price pricing strategy because this strategy does not use sizes.\n\nSee the Pricing strategies section in the Toast Platform Guide for information on the Size Price, Sequence Price, and Size/Sequence Price pricing strategies.\n", "x-nullable": true, "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1" }, "sequencePrices": { "type": "array", "description": "An array of `SequencePrices` objects that define the size, sequence, or size/sequence prices for the modifier options in this modifier group.\n\nBecause they are multi use objects, the `SequencePrices` objects always contain `sequence` and `price` values for all three pricing strategies. However, the `sequence` is always 1 for the Size Price pricing strategy because only one price is defined per size for that strategy. For example, the `sequencePrices` value for a modifier group priced using the Size Price pricing strategy looks similar to the following:\n```\n\"sizeSequencePricingRules\": [\n {\n \"sizeName\": \"Small\",\n \"sizeGuid\": \"e02d1a57-5f9f-4800-a8c3-a5fe1a0b029b\",\n \"sequencePrices\": [\n {\n \"sequence\": 1,\n \"price\": 2\n }\n ]\n },\n {\n \"sizeName\": \"Large\",\n \"sizeGuid\": \"0e206b2d-72ab-46d1-b273-a5425cbef9a5\",\n \"sequencePrices\": [\n {\n \"sequence\": 1,\n \"price\": 4\n }\n ]\n }\n ]\n``` \n\nThe modifier options in this group cost $2.00 for the Small size and $4.00 for the Large size.\n\nThe `sequencePrices` value for a modifier group priced using the Sequence Price pricing strategy looks like this:\n```\n\"sizeSequencePricingRules\": [\n {\n \"sizeName\": null,\n \"sizeGuid\": null,\n \"sequencePrices\": [\n {\n \"sequence\": 1,\n \"price\": 1\n },\n {\n \"sequence\": 2,\n \"price\": 2\n },\n {\n \"sequence\": 3,\n \"price\": 2.5\n }\n ]\n }\n ]\n```\n\nThe first modifier option in this group costs $1.00, the second modifier option costs $2.00, and any additional modifier options from this group costs $2.50.\n\nThe `sequencePrices` value for a modifier group using the Size/Sequence Price pricing strategy looks like this:\n```\n\"sizeSequencePricingRules\": [\n {\n \"sizeName\": \"Small\",\n \"sizeGuid\": \"e02d1a57-5f9f-4800-a8c3-a5fe1a0b029b\",\n \"sequencePrices\": [\n {\n \"sequence\": 1,\n \"price\": 1\n },\n {\n \"sequence\": 2,\n \"price\": 2\n }\n ]\n },\n {\n \"sizeName\": \"Large\",\n \"sizeGuid\": \"0e206b2d-72ab-46d1-b273-a5425cbef9a5\",\n \"sequencePrices\": [\n {\n \"sequence\": 1,\n \"price\": 3\n },\n {\n \"sequence\": 2,\n \"price\": 4\n }\n ]\n }\n ]\n```\n\nThe first modifier option on a Small menu item costs $1.00 and additional modifier options on a Small cost $2.00, while the first modifier option on a Large menu item costs $3.00 and additional modifier options on a Large cost $4.00.\n", "items": { "$ref": "#/$defs/SequencePrice" } } } }, "SequencePrice": { "type": "object", "description": "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/Sequence Price pricing strategy.\n", "properties": { "sequence": { "type": "integer", "format": "int32", "description": "Specifies the order of the prices.\n\nFor modifier groups that use the Size Price pricing strategy, the `sequence` is always 1 because only one price is defined per size for that strategy.\n\nFor modifier groups that use the Sequence Price or Size/Sequence Price pricing strategy, this value starts at 1 and increases with each successive price in the sequence. For example, in the JSON snippet below, `\"sequence\":1` defines the first price in the sequence and `\"sequence\":2` defines the second price in the sequence.\n```\n\"sequencePrices\": [\n {\n \"sequence\": 1,\n \"price\": 3\n },\n {\n \"sequence\": 2,\n \"price\": 4\n }\n ]\n```\n", "example": 1 }, "price": { "type": "number", "format": "double", "description": "The price for a modifier option when it is ordered at the specified point in the sequence.\n", "example": 1.0 } } }, "SalesCategory": { "type": "object", "description": "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 category. Null if no sales category has been defined.\n", "properties": { "name": { "description": "A descriptive name for this sales category, for example, \"Food\" or \"Liquor\".\n", "type": "string", "example": "Example Name" }, "guid": { "description": "A unique identifier for this sales category, assigned by the Toast POS system.\n", "type": "string", "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1" } } }, "ItemTag": { "type": "object", "description": "A descriptive term that identifies a characteristic of a menu item or menu group, for example, vegetarian, gluten-free, or alcohol.\n", "properties": { "name": { "description": "A descriptive name for this item tag, for example, \"Vegetarian\" or \"Alcohol\".\n", "type": "string", "example": "Example Name" }, "guid": { "description": "A unique identifier for this item tag category, assigned by the Toast POS system.\n", "type": "string", "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1" } } }, "ContentAdvisories": { "type": "object", "description": "Information about the contents of this menu item or modifier, for example, whether it contains alcohol.\n", "properties": { "alcohol": { "$ref": "#/$defs/Alcohol" } } }, "Alcohol": { "type": "object", "description": "Information about whether this menu item or modifier contains alcohol and may require, \nor benefit from, additional handling. For example, a delivery partner may need \nto identify a menu item or modifier as containing alcohol to ensure that delivery drivers\nrequest identification before giving it to a customer.\n", "properties": { "containsAlcohol": { "type": "string", "description": "A string that indicates whether the menu item or modifier contains alcohol. Possible values \ninclude:\n\n* `YES`: The menu item or modifier contains alcohol.\n* `NO`: The menu item or modifier does not contain alcohol.\n \nThe `containsAlcohol` value may also be `null`. A `null` value indicates that the corresponding UI option in Toast Web has not been configured for this menu item or modifier.\n", "enum": [ "YES", "NO" ], "example": "YES" } } }, "Portion": { "type": "object", "description": "A container for the modifier groups that can be applied to a portion of a menu item.\n", "properties": { "name": { "description": "A descriptive name for this portion, for example, \"1st Half\" or \"2nd Half\".\n", "type": "string", "example": "Example Name" }, "guid": { "description": "A unique identifier for this portion, assigned by the Toast POS system.\n", "type": "string", "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1" }, "modifierGroupReferences": { "type": "array", "description": "An array of `referenceId`s for `ModifierGroup` objects. These objects define the modifier groups that can be applied to this portion.\n", "minItems": 0, "items": { "type": "integer" } }, "priceScaleFactor": { "type": "number", "format": "double", "description": "A multiplier that adjusts the cost of modifiers in this portion.\n", "x-nullable": true, "example": 1.0 } } }, "AllergenItem": { "type": "object", "description": "Reserved for future functionality. Not currently supported for external integrations.\n", "properties": { "guid": { "description": "Reserved for future functionality. Not currently supported for external integrations.\n", "type": "string", "format": "uuid", "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1" }, "code": { "description": "Reserved for future functionality. Not currently supported for external integrations.\n", "type": "string", "example": "string" }, "groupGuid": { "description": "Reserved for future functionality. Not currently supported for external integrations.\n", "type": "string", "format": "uuid", "x-nullable": true, "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1" }, "groupCode": { "description": "Reserved for future functionality. Not currently supported for external integrations.\n", "type": "string", "x-nullable": true, "example": "string" }, "presenceType": { "type": "string", "description": "Reserved for future functionality. Not currently supported for external integrations.\n", "enum": [ "CONTAINS", "TRACES" ], "x-nullable": true, "example": "CONTAINS" } } }, "Length": { "type": "number", "description": "The length of the item or modifier. Use the `dimensionUnitOfMeasure` value to determine the unit of measurement.\n\nThe `length` value is `null` if no length is specified for the item or modifier.\n\nYou can use the `length`, `height`, and `width` values to determine the overall size of the item or modifier. This information is useful, for example, when determining shipping costs or choosing the size of delivery vehicle to use.\n", "format": "float", "x-nullable": true }, "Height": { "type": "number", "description": "The height of the item or modifier. Use the `dimensionUnitOfMeasure` value to determine the unit of measurement.\n\nThe `height` value is `null` if no height is specified for the item or modifier.\n\nYou can use the `length`, `height`, and `width` values to determine the overall size of the item or modifier. This information is useful, for example, when determining shipping costs or choosing the size of delivery vehicle to use.\n", "format": "float", "x-nullable": true }, "Width": { "type": "number", "description": "The width of the item or modifier. Use the `dimensionUnitOfMeasure` value to determine the unit of measurement.\n\nThe `width` value is `null` if no width is specified for the item or modifier.\n\nYou can use the `length`, `height`, and `width` values to determine the overall size of the item or modifier. This information is useful, for example, when determining shipping costs or choosing the size of delivery vehicle to use.\n", "format": "float", "x-nullable": true }, "DimensionUnitOfMeasure": { "type": "string", "enum": [ "IN", "CM", "FT", "M", "MM", "YD" ], "description": "The unit of measure assigned to the `length`, `height`, and `width` values.\n \nPossible values include:\n \n* IN: Inches\n* CM: Centimeters\n* FT: Feet\n* M: Meters\n* MM: Millimeters\n* YD: Yards\n \n`dimensionUnitOfMeasure` is `null` if no unit of measurement has been specified.\n", "x-nullable": true }, "Weight": { "type": "number", "description": "The weight of the item or modifier. Use the `weightUnitOfMeasure` value to determine the unit of measurement.\n\nTh `weight` value is `null` if no weight is specified for the item or modifier.\n \nYou can use the `weight` value when determining shipping costs or choosing a delivery vehicle to use.\n", "format": "float", "x-nullable": true }, "WeightUnitOfMeasure": { "type": "string", "enum": [ "NONE", "LB", "OZ", "KG", "G" ], "description": "The unit of measure assigned to the `weight` value.\n \nPossible values include:\n \n* NONE: No unit of measurement is assigned. `weightUnitOfMeasure` can also be `null`. `NONE` and `null` are equivalent. \n* LB: Pounds\n* OZ: Ounces\n* KG: Kilograms\n* G: Grams\n", "x-nullable": true }, "Images": { "type": "array", "description": "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.\n \n_Note:_ The `images` array contains multiple URLs for multiple images for the same item or modifier. The older `image` value contains a single URL for a single image.\n", "items": { "type": "string" } }, "GuestCount": { "type": "number", "description": "The number of guests the item or modifier is expected to serve. This value is `null` if no guest count is specified.\n", "format": "float", "x-nullable": true }, "CatalogProductInfo": { "type": "object", "description": "Contains retail catalog product information for a menu item.\n", "properties": { "product": { "$ref": "#/$defs/CatalogProduct" }, "productVariant": { "$ref": "#/$defs/CatalogProductVariant" } }, "x-nullable": true }, "CatalogProduct": { "type": "object", "description": "Retail catalog product information for a menu item.\n", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier of the retail product in the retail product catalog. This is different from the menu item identifier.\n", "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1" }, "name": { "type": "string", "description": "The name of the product, for example, \"T-Shirt\".\n", "example": "Example Name" }, "description": { "type": "string", "description": "The description of the product.\n", "x-nullable": true, "example": "string" }, "type": { "type": "string", "enum": [ "SINGLE", "OPTION", "UNSPECIFIED" ], "description": "The type of product. Possible values include:\n\n* `SINGLE`: The product has exactly one variant and does not have any options.\n* `OPTION`: The product is an option-type product and will contain at least one variant and at least one option.\n* `UNSPECIFIED`: Product type is not specified or unknown.\n", "example": "SINGLE" }, "images": { "type": "array", "description": "List of image URLs for the product. A product can have different images than its variants.\n", "items": { "type": "string" } }, "availableOptions": { "type": "array", "description": "List of available options for the product.\n", "items": { "$ref": "#/$defs/CatalogProductOption" } } } }, "CatalogProductOption": { "type": "object", "description": "An option for a retail product.\n", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier for the product option.\n", "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1" }, "name": { "type": "string", "description": "The name of the product option, for example, \"size\".\n", "example": "Example Name" }, "sortOrder": { "type": "integer", "description": "The sort order of the product option.\n", "example": 1 }, "values": { "type": "array", "description": "List of values for the product option.\n", "items": { "$ref": "#/$defs/CatalogProductOptionValue" } } } }, "CatalogProductOptionValue": { "type": "object", "description": "A value within a catalog product option.\n", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier for the product option value.\n", "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1" }, "name": { "type": "string", "description": "The name of the product option value, for example, \"small\".\n", "example": "Example Name" }, "sortOrder": { "type": "integer", "description": "The sort order of the product option value.\n", "example": 1 } } }, "CatalogProductVariant": { "type": "object", "description": "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 options `Red` and size `Small`).\n", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier for the product variant.\n", "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1" }, "name": { "type": "string", "description": "The name of the variant, for example, \"T-Shirt - Small\".\n", "example": "Example Name" }, "description": { "type": "string", "description": "The description of the variant.\n", "x-nullable": true, "example": "string" }, "selectedOptions": { "type": "array", "description": "List of selected options for the variant.\n", "items": { "$ref": "#/$defs/CatalogProductVariantOption" } } } }, "CatalogProductVariantOption": { "type": "object", "description": "A selected option for a retail product variant.\n", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier for the product variant option.\n", "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1" }, "name": { "type": "string", "description": "The name of the product variant option, for example, \"size\".\n", "example": "Example Name" }, "sortOrder": { "type": "integer", "description": "The sort order of the product variant option.\n", "example": 1 }, "value": { "$ref": "#/$defs/CatalogProductOptionValue" } } } } }