Information about the restaurant whose menu data has been retrieved.
lastUpdated | string The most recent date and time that this menu's data was published. Use this value to determine if you need to refresh your menu data. The |
Array of objects (Menu) An array of | |
object A map of
Other menu entities refer to modifier groups using their | |
object A map of
Other menu entities refer to modifier options using their | |
object A map of
Other menu entities refer to premodifier groups using their | |
restaurantGuid | string <uuid> A unique identifier for this restaurant, assigned by the Toast POS system. |
restaurantTimeZone | string The name of the restaurant's time zone in the IANA time zone database https://www.iana.org/time-zones. For example, "America/New_York". |
{- "restaurantGuid": "ea0a8ddc-1996-4cd1-bc9b-c9aaabff38dc",
- "lastUpdated": "string",
- "restaurantTimeZone": "string",
- "menus": [
- {
- "name": "string",
- "guid": "string",
- "multiLocationId": "string",
- "masterId": 0,
- "description": "string",
- "posName": "string",
- "posButtonColorLight": "string",
- "posButtonColorDark": "string",
- "highResImage": "string",
- "image": "string",
- "visibility": [
- "POS"
], - "availability": { },
- "menuGroups": [
- {
- "name": "string",
- "guid": "string",
- "multiLocationId": "string",
- "masterId": 0,
- "description": "string",
- "posName": "string",
- "posButtonColorLight": "string",
- "posButtonColorDark": "string",
- "image": "string",
- "visibility": [
- "POS"
], - "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",
- "visibility": [
- null
], - "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",
- "visibility": [
- "POS"
], - "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",
- "visibility": [
- "POS"
], - "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",
- "visibility": [
- "POS"
], - "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",
- "visibility": [
- "POS"
], - "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"
}
]
}
}
}