Toast Menus API

swagger: '2.0'
info:
  version: 1.0.0
  title: Toast Authentication Menus API
  description: 'The authentication API returns an authentication token that you can present

    when your integration client software uses other Toast APIs. For more

    information about authentication, see [the Toast Developer

    Guide](https://doc.toasttab.com/doc/devguide/authentication.html).

    '
  termsOfService: https://pos.toasttab.com/api-terms-of-use
  contact:
    name: Toast developer support
host: toast-api-server
basePath: /authentication/v1
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: Menus
paths:
  /menus:
    get:
      operationId: menusGet
      summary: Toast Get Menus
      description: 'Get menus

        '
      produces:
      - application/json
      parameters:
      - name: Toast-Restaurant-External-ID
        description: The identifier for the restaurant.
        in: header
        required: true
        type: string
        format: uuid
      responses:
        '200':
          description: Successful operation
          schema:
            $ref: '#/definitions/Restaurant'
        '404':
          description: No published data was found for the restaurant. Ensure that the restaurant GUID is correct and that its data has been published.
        '503':
          description: Unable to retrieve menus for the restaurant due to a service outage.
      security:
      - oauth2:
        - menus:read
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Menus
definitions:
  ModifierGroup:
    type: object
    description: 'Information about a modifier group configured for this restaurant, including an array of modifier options contained in the group.

      '
    properties:
      name:
        description: 'A descriptive name for this modifier group, for example, "Pizza Toppings" or "Salad Dressings".

          '
        type: string
        example: Example Name
      guid:
        description: 'A unique identifier for this modifier group, assigned by the Toast POS system.

          '
        type: string
        example: 5a401af8-d2e2-4090-8c45-9f87b8b6c4d1
      referenceId:
        description: 'An integer identifier that is used to refer to this modifier group by items and portions that use it.

          '
        type: integer
        example: 1
      multiLocationId:
        $ref: '#/definitions/MultiLocationId'
      masterId:
        $ref: '#/definitions/MasterId'
      posName:
        $ref: '#/definitions/PosName'
      posButtonColorLight:
        $ref: '#/definitions/PosButtonColorLight'
      posButtonColorDark:
        $ref: '#/definitions/PosButtonColorDark'
      visibility:
        $ref: '#/definitions/Visibility'
      pricingStrategy:
        type: string
        description: "A string that represents the pricing strategy used for this modifier group.\n\nIf there is no additional charge for the modifier options in this group, or if the modifier options in the group are priced individually, then the `pricingStrategy` value is NONE.\n\nIf the modifier group is priced at the group level and is using the:\n  * Fixed Price pricing strategy, then the `pricingStrategy` value is NONE.\n  * Sequence Price pricing strategy, then the `pricingStrategy` value is SEQUENCE_PRICE.\n  * Size Price pricing strategy, then the `pricingStrategy` value is SIZE_PRICE.\n  * Size/Sequence Price pricing strategy, then the `pricingStrategy` value is SIZE_SEQUENCE_PRICE.\n\n  \nIf the `pricingStrategy` value is NONE,  then the prices for the modifier options in this group are resolved down to the modifier option level and you can retrieve them from the `price` value of the individual `ModifierOption` objects.\n\nIf the `pricingStrategy` value is SIZE_PRICE, SEQUENCE_PRICE, or SIZE_SEQUENCE_PRICE, then you must use the rules provided in _this modifier group's_ `pricingRules` value to calculate the prices for the modifier options in the group.\n"
        example: string
      pricingRules:
        type: object
        description: 'A `PricingRules` object with information for calculating the prices for the modifier options contained in this modifier group. You use a modifier group''s `pricingRules` object, in conjunction with its `pricingStrategy` value, to calculate prices for the group''s modifier options when the group uses the Size Price, Sequence Price, or Size/Sequence Price pricing strategy.


          The `pricingRules` object takes different forms depending on the pricing strategy configured for the modifier group. Use the `pricingStrategy` value to determine which pricing strategy has been used so that you can properly interpret the data in the `pricingRules` object. If the `pricingStrategy` value is NONE, the `pricingRules` object is null because you can retrieve the price from a `ModifierOption` object''s `price` value without additional calculation. For the SIZE_PRICE, SEQUENCE_PRICE, and SIZE_SEQUENCE_PRICE pricing strategies, the `pricingRules` object contains additional values that you use to calculate the modifier option prices.

          '
        items:
          $ref: '#/definitions/PricingRules'
        x-nullable: true
      defaultOptionsChargePrice:
        description: "Indicates whether the prices associated with any default modifiers in this group are added to the cost of the menu items they modify.\n\nValues are:\n  * NO: The default modifier price is ignored. No change is made to the cost of the menu item.\n  * YES: The default modifier price is added to the menu item price. YES is the default setting for `defaultOptionsChargePrice`.\n\nFor example, consider a scenario where Cheese is a default modifier for a Burger menu item (this means that Cheese is always included as a modifier option when you order a Burger unless it is explicitly removed). The price of the Cheese modifier option is $1 while the price of the Burger is $8. When `defaultOptionsChargePrice` is set to NO, a Burger costs $8 (the Cheese default modifier price is not added to the Burger price). When `defaultOptionsChargePrice` is set to YES, a Burger costs $9 (the Cheese default modifier price is added to the Burger price). If the Cheese default modifier is removed from the Burger menu item, the price of the Burger remains $8. Removing a default modifier from a menu item does not change the menu item’s price, regardless of the `defaultOptionsChargePrice` setting.\n\nThe `defaultOptionsChargePrice` value must be set to NO in order to use substitution pricing. See `defaultOptionsSubstitutionPricing` for more information.\n"
        type: string
        enum:
        - false
        - true
        example: false
      defaultOptionsSubstitutionPricing:
        description: "Indicates whether substitution pricing is enabled for the modifier group.\n\nIn Toast Web, you must set the `defaultOptionsChargePrice` configuration for a modifier group to NO before you can enable substitution pricing for the group. This means that the costs of default modifiers in the group do not increase the price of the menu items they apply to. These default modifiers continue to have a monetary value, however. By enabling substitution pricing, you are configuring the modifier group so that if any of its default modifiers are removed from a menu item, the monetary value of those default modifiers can be applied to the purchase of other modifier options within the same modifier group (even though the cost of those default modifiers was not explicitly added to the cost of the menu item).\n\nFor example, a guest orders a salad that comes with chicken by default but asks to substitute salmon for the chicken. The price of the chicken option is $7. The price of the salmon option is $9. In this case, the Toast POS system calculates the difference and charges the substitution price of $2 for the salmon (not the regular price of $9).\n\nValues for `defaultOptionsSubstitutionPricing` include:\n  * YES: Substitution pricing is enabled. Substitution pricing allows a guest to remove one or more default modifiers from a menu item and apply the value of those modifiers toward the purchase of one or more other modifier options in the same modifier group.\n  * NO: Substitution pricing is not enabled. Removing a default modifier from a menu item has no impact on the price of the menu item or on any other modifier options that get added. For example, a guest orders a burger that comes with cheese by default but asks to substitute bacon instead of cheese. The price of the burger is $8. The price of the default cheese modifier is $1 but it is not added to the cost of the burger because `defaultOptionsChargePrice` is set to NO. The price of the bacon modifier option is $3. In this scenario, the customer would pay $11, $8 for the burger and $3 for the bacon. No credit is given for removing the cheese modifier option. `NO` is the default setting for `defaultOptionsSubstitutionPricing`.\n\nRemoving default modifiers from a menu item never reduces the price of the menu item. If you remove the chicken from a $10 salad that includes chicken by default, the price of the salad remains $10. If you remove the chicken and substitute other modifier options that cost less than the chicken, the price of the salad remains $10. If you remove the chicken and replace it with modifier options that cost more than the chicken, the price increases by the difference in modifier option cost if you have substitution pricing enabled.\n"
        type: string
        enum:
        - false
        - true
        example: false
      minSelections:
        type: integer
        description: "The minimum number of modifier options that a customer can choose from this modifier group.\n\nIf a server is not required to select a modifier option from this modifier group, `minSelections` is set to 0.\n\nIf a server must select a modifier option from this modifier group, `minSelections` must be set to 1 or higher. For example, a Temperature modifier group could be set to 1 to require a server to choose a temperature (Rare, Medium Rare, Medium, or Well Done) when placing a steak order. The orders API rejects an order if it does not follow the `minSelections` requirement for a modifier group.\n\nThe `minSelections` and `maxSelections` values can be used in conjunction with one another. For example, consider the following modifier group configuration:\n\n* Modifier Group: Cheese\n* Modifier Options: ( Cheddar, American, Swiss )\n* maxSelections: 2\n* minSelections: 1\n\nWith this configuration:\n  * You can select AT MOST two different cheeses from this group to apply to the menu item (the `maxSelections` value).\n  * You must select AT LEAST one cheese from this group to apply to the menu item (the `minSelections` value).\n"
        example: 1
      maxSelections:
        type: integer
        description: "The maximum number of modifier options that a customer can choose from this modifier group. `maxSelections` is null if a customer can choose an unlimited number of modifier options from this modifier group. It is 1 if the modifier group is not enabled for multiple selections. The orders API rejects an order if it does not follow the `maxSelections` requirement for a modifier group.\n\nThe `minSelections` and `maxSelections` values can be used in conjunction with one another. For example, consider the following modifier group configuration:\n\n* Modifier Group: Cheese\n* Modifier Options: ( Cheddar, American, Swiss )\n* maxSelections: 2\n* minSelections: 1\n\nWith this configuration:\n  * You can select AT MOST two different cheeses from this group to apply to the menu item (the `maxSelections` value).\n  * You must select AT LEAST one cheese from this group to apply to the menu item (the `minSelections` value).\n"
        x-nullable: true
        example: 1
      requiredMode:
        description: "Specifies how the modifier group appears and behaves in the Toast POS app. Values include:\n  * REQUIRED: Forces a server to make a selection from the modifier group before continuing to the next screen in the Toast POS app. Note that the orders API rejects an order if a modifier option is not included for a modifier group whose `requiredMode` value is set to REQUIRED.\n  * OPTIONAL FORCE SHOW: Prompts the server to view the modifier group but does not force them to choose a modifier option from it before continuing to the next screen in the Toast POS app. This setting is typically used for upselling.\n  * OPTIONAL: The modifier group does not appear when an associated menu item is selected but the server can access it on the Toast POS app if necessary.\n"
        type: string
        enum:
        - REQUIRED
        - OPTIONAL_FORCE_SHOW
        - OPTIONAL
        example: REQUIRED
      isMultiSelect:
        type: boolean
        description: 'Indicates whether you can select more than one modifier option from this modifier group.


          The `isMultiSelect` value provides similar information to the `maxSelections` value in a different format. If `isMultiSelect` is TRUE, then by definition more than one modifier option can be selected from the modifier group, so `maxSelections` must be greater than 1 or null (a null value indicates that an unlimited number of selections can be made from the modifier group). If `isMultiSelect` is FALSE, then only one modifier option may be selected from the modifier group and the Toast POS system enforces a setting of 1 for `maxSelections`.


          Also, if `isMultiSelect` is FALSE for a modifier group, the Toast POS system enforces a setting of FALSE for the `allowsDuplicates`  value of the group’s modifier options. This prevents more than one instance of a modifier option being selected for the group. Similarly, the orders API rejects any orders that specify more than one modifier option for a modifier group whose `isMultiSelect` value is FALSE.

          '
        example: true
      preModifierGroupReference:
        type: integer
        description: 'The `referenceId` of a `PreModifierGroup` object. This object defines the premodifiers that can be applied to the modifier options contained in this modifier group. Premodifiers alter the display of modifier options on receipts and tickets to satisfy guest requests such as EXTRA or ON THE SIDE. Premodifiers can also be configured to modify the cost of the modifier options they are applied to, for example, by charging more for an EXTRA serving of a modifier option.

          '
        example: 1
      modifierOptionReferences:
        type: array
        description: 'An array of `referenceId`s for `ModifierOption` objects. These objects define the modifier options contained in this modifier group.

          '
        minItems: 0
        items:
          type: integer
  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
  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`).

      '
    properties:
      id:
        type: string
        format: uuid
        description: 'The unique identifier for the product variant.

          '
        example: 5a401af8-d2e2-4090-8c45-9f87b8b6c4d1
      name:
        type: string
        description: 'The name of the variant, for example, "T-Shirt - Small".

          '
        example: Example Name
      description:
        type: string
        description: 'The description of the variant.

          '
        x-nullable: true
        example: string
      selectedOptions:
        type: array
        description: 'List of selected options for the variant.

          '
        items:
          $ref: '#/definitions/CatalogProductVariantOption'
  PricingRules:
    type: object
    description: "The PricingRules object is a multi-use object that provides pricing rules for:\n  * A menu item or modifier option <a href=\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\">item reference</a> 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 <a href="https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference">item reference</a> 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.

          '
        type: array
        items:
          $ref: '#/definitions/TimeSpecificPrice'
      sizeSpecificPricingGuid:
        description: "The GUID of a Size modifier group that defines sizes and prices for a menu item or a modifier option <a href=\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\">item reference</a> 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.

          '
        items:
          $ref: '#/definitions/SizeSequencePricingRule'
  MenuItem:
    type: object
    description: 'Information about a menu item configured for this restaurant.

      '
    properties:
      name:
        description: 'A descriptive name for this menu item, for example, "Caesar Salad" or "Turkey Sandwich".


          To 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.


          Note 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’s 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.


          To 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.

          '
        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.

          '
        example: Example Name
      guid:
        description: 'A unique identifier for this menu item, assigned by the Toast POS system.

          '
        type: string
        example: 5a401af8-d2e2-4090-8c45-9f87b8b6c4d1
      multiLocationId:
        $ref: '#/definitions/MultiLocationId'
      masterId:
        $ref: '#/definitions/MasterId'
      description:
        description: 'An optional short description of this menu item.

          '
        type: string
        example: string
      posName:
        $ref: '#/definitions/PosName'
      posButtonColorLight:
        $ref: '#/definitions/PosButtonColorLight'
      posButtonColorDark:
        $ref: '#/definitions/PosButtonColorDark'
      image:
        $ref: '#/definitions/Image'
      visibility:
        $ref: '#/definitions/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 <a href=\"https://doc.toasttab.com/doc/platformguide/adminToastPosPricingFeatures.html\">Menu Pricing</a> 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_SPE

# --- truncated at 32 KB (116 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/toast-tab/refs/heads/main/openapi/toast-tab-menus-api-openapi.yml