Get menus

Get menus

Securityoauth2

Request

header Parameters

• Toast-Restaurant-External-ID required:
  string <uuid>

  The identifier for the restaurant.

Responses

200

Successful operation

404

No published data was found for the restaurant. Ensure that the restaurant GUID is correct and that its data has been published.

503

Unable to retrieve menus for the restaurant due to a service outage.

get /menus

Request samples

curl -i -X GET \
  https://toast-api-server/menus/v3/menus \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Response samples

application/json

{
  "restaurantGuid": "ea0a8ddc-1996-4cd1-bc9b-c9aaabff38dc",
  "lastUpdated": "string",
  "restaurantTimeZone": "string",
  "menus": [
    {
      "name": "string",
      "guid": "string",
      "multiLocationId": "string",
      "masterId": 0,
      "description": "string",
      "posButtonColorLight": "string",
      "posButtonColorDark": "string",
      "highResImage": "string",
      "image": "string",
      "availability": { },
      "menuGroups": [
        {
          "name": "string",
          "guid": "string",
          "multiLocationId": "string",
          "masterId": 0,
          "description": "string",
          "posName": "string",
          "posButtonColorLight": "string",
          "posButtonColorDark": "string",
          "image": "string",
          "itemTags": [
            {
              "name": "string",
              "guid": "string"
            }
          ],
          "menuGroups": [
            { }
          ],
          "menuItems": [
            {
              "name": "string",
              "kitchenName": "string",
              "guid": "string",
              "multiLocationId": "string",
              "masterId": 0,
              "description": "string",
              "posName": "string",
              "posButtonColorLight": "string",
              "posButtonColorDark": "string",
              "image": "string",
              "price": 0,
              "pricingStrategy": "BASE_PRICE",
              "pricingRules": [
                null
              ],
              "isDeferred": true,
              "isDiscountable": true,
              "salesCategory": {
                "name": null,
                "guid": null
              },
              "taxInfo": [
                null
              ],
              "taxInclusion": "TAX_INCLUDED",
              "itemTags": [
                null
              ],
              "plu": "string",
              "sku": "string",
              "calories": 0,
              "contentAdvisories": {
                "alcohol": null
              },
              "unitOfMeasure": "NONE",
              "portions": [
                null
              ],
              "prepTime": 0,
              "prepStations": [
                null
              ],
              "modifierGroupReferences": [
                null
              ]
            }
          ]
        }
      ]
    }
  ],
  "modifierGroupReferences": {
    "identifier": 0,
    "property1": {
      "name": "string",
      "guid": "string",
      "referenceId": 0,
      "multiLocationId": "string",
      "masterId": 0,
      "posName": "string",
      "posButtonColorLight": "string",
      "posButtonColorDark": "string",
      "pricingStrategy": "string",
      "pricingRules": [
        {
          "timeSpecificPricingRules": [
            {
              "timeSpecificPrice": 0,
              "basePrice": 0,
              "schedule": [
                null
              ]
            }
          ],
          "sizeSpecificPricingGuid": "string",
          "sizeSequencePricingRules": [
            {
              "sizeName": "string",
              "sizeGuid": "string",
              "sequencePrices": [
                null
              ]
            }
          ]
        }
      ],
      "defaultOptionsChargePrice": "NO",
      "defaultOptionsSubstitutionPricing": "NO",
      "minSelections": 0,
      "maxSelections": 0,
      "requiredMode": "REQUIRED",
      "isMultiSelect": true,
      "preModifierGroupReference": 0,
      "modifierOptionReferences": [
        0
      ]
    },
    "property2": {
      "name": "string",
      "guid": "string",
      "referenceId": 0,
      "multiLocationId": "string",
      "masterId": 0,
      "posName": "string",
      "posButtonColorLight": "string",
      "posButtonColorDark": "string",
      "pricingStrategy": "string",
      "pricingRules": [
        {
          "timeSpecificPricingRules": [
            {
              "timeSpecificPrice": 0,
              "basePrice": 0,
              "schedule": [
                null
              ]
            }
          ],
          "sizeSpecificPricingGuid": "string",
          "sizeSequencePricingRules": [
            {
              "sizeName": "string",
              "sizeGuid": "string",
              "sequencePrices": [
                null
              ]
            }
          ]
        }
      ],
      "defaultOptionsChargePrice": "NO",
      "defaultOptionsSubstitutionPricing": "NO",
      "minSelections": 0,
      "maxSelections": 0,
      "requiredMode": "REQUIRED",
      "isMultiSelect": true,
      "preModifierGroupReference": 0,
      "modifierOptionReferences": [
        0
      ]
    }
  },
  "modifierOptionReferences": {
    "identifier": 0,
    "property1": {
      "referenceId": 0,
      "name": "string",
      "kitchenName": "string",
      "guid": "string",
      "multiLocationId": "string",
      "masterId": 0,
      "description": "string",
      "posName": "string",
      "posButtonColorLight": "string",
      "posButtonColorDark": "string",
      "prepStations": [
        "string"
      ],
      "image": "string",
      "price": 0,
      "pricingStrategy": "string",
      "pricingRules": [
        {
          "timeSpecificPricingRules": [
            {
              "timeSpecificPrice": 0,
              "basePrice": 0,
              "schedule": [
                null
              ]
            }
          ],
          "sizeSpecificPricingGuid": "string",
          "sizeSequencePricingRules": [
            {
              "sizeName": "string",
              "sizeGuid": "string",
              "sequencePrices": [
                null
              ]
            }
          ]
        }
      ],
      "salesCategory": {
        "name": "string",
        "guid": "string"
      },
      "taxInfo": [
        "string"
      ],
      "modifierOptionTaxInfo": {
        "taxRateGuids": [
          "string"
        ],
        "overrideItemTaxRates": true
      },
      "itemTags": [
        {
          "name": "string",
          "guid": "string"
        }
      ],
      "plu": "string",
      "sku": "string",
      "calories": 0,
      "contentAdvisories": {
        "alcohol": {
          "containsAlcohol": "YES"
        }
      },
      "unitOfMeasure": "NONE",
      "isDefault": true,
      "allowsDuplicates": true,
      "portions": [
        {
          "name": "string",
          "guid": "string",
          "modifierGroupReferences": [
            0
          ]
        }
      ],
      "prepTime": 0,
      "modifierGroupReferences": [
        0
      ]
    },
    "property2": {
      "referenceId": 0,
      "name": "string",
      "kitchenName": "string",
      "guid": "string",
      "multiLocationId": "string",
      "masterId": 0,
      "description": "string",
      "posName": "string",
      "posButtonColorLight": "string",
      "posButtonColorDark": "string",
      "prepStations": [
        "string"
      ],
      "image": "string",
      "price": 0,
      "pricingStrategy": "string",
      "pricingRules": [
        {
          "timeSpecificPricingRules": [
            {
              "timeSpecificPrice": 0,
              "basePrice": 0,
              "schedule": [
                null
              ]
            }
          ],
          "sizeSpecificPricingGuid": "string",
          "sizeSequencePricingRules": [
            {
              "sizeName": "string",
              "sizeGuid": "string",
              "sequencePrices": [
                null
              ]
            }
          ]
        }
      ],
      "salesCategory": {
        "name": "string",
        "guid": "string"
      },
      "taxInfo": [
        "string"
      ],
      "modifierOptionTaxInfo": {
        "taxRateGuids": [
          "string"
        ],
        "overrideItemTaxRates": true
      },
      "itemTags": [
        {
          "name": "string",
          "guid": "string"
        }
      ],
      "plu": "string",
      "sku": "string",
      "calories": 0,
      "contentAdvisories": {
        "alcohol": {
          "containsAlcohol": "YES"
        }
      },
      "unitOfMeasure": "NONE",
      "isDefault": true,
      "allowsDuplicates": true,
      "portions": [
        {
          "name": "string",
          "guid": "string",
          "modifierGroupReferences": [
            0
          ]
        }
      ],
      "prepTime": 0,
      "modifierGroupReferences": [
        0
      ]
    }
  },
  "preModifierGroupReferences": {
    "identifier": 0,
    "property1": {
      "name": "string",
      "guid": "string",
      "multiLocationId": "string",
      "preModifiers": [
        {
          "name": "string",
          "guid": "string",
          "multiLocationId": "string",
          "fixedPrice": 0,
          "multiplicationFactor": 0,
          "displayMode": "PREFIX",
          "posName": "string",
          "posButtonColorLight": "string",
          "posButtonColorDark": "string"
        }
      ]
    },
    "property2": {
      "name": "string",
      "guid": "string",
      "multiLocationId": "string",
      "preModifiers": [
        {
          "name": "string",
          "guid": "string",
          "multiLocationId": "string",
          "fixedPrice": 0,
          "multiplicationFactor": 0,
          "displayMode": "PREFIX",
          "posName": "string",
          "posButtonColorLight": "string",
          "posButtonColorDark": "string"
        }
      ]
    }
  }
}