When you use the orders API to post an order, you must identify the menu groups, menu items, modifier groups, and modifiers that are included in the order.
To do this, you can provide either:
-
The unique
guidassigned to each menu entity. You can see examples of that in Order details based on the order dining option and Specifying modifiers and instructions for menu item selections. -
The
multilocationIdfor each menu entity. This is the recommended option, especially for restaurants that use the multi-location management module (previously known as the "enterprise module").
For information about guid and
multilocationId values and using them in API requests, see
Toast identifiers.
Note that for each menu entity, you must submit either a
guid OR a multiLocationId. You cannot submit both
identifiers. When you submit both types of identifier for a menu entity, the
order submission fails.
You can submit guid values for some menu entities and
multiLocationId values for others. You cannot submit both a
guid and a multiLocationId for the same
menu entity.
The following example shows a request to the /orders
endpoint that uses multiLocationId values.
{ 
"diningOption": {
"guid": "03e8796d-6eeb-460c-83fe-376766003059",
},
"checks": [
{
"selections": [
{
"itemGroup": { 
"multiLocationId": "500000008202847047",
},
"item": { 
"multiLocationId": "500000008202871058"
},
"quantity": 1,
"modifiers": [
{
"optionGroup": { 
"multiLocationId": "500000000111604139"
},
"item": { 
"multiLocationId": "500000000106492270"
},
"quantity": 1
},
{
"optionGroup": {
"multiLocationId": "500000000106491932"
},
"item": {
"multiLocationId": "500000000099996428"
},
"quantity": 1
}
]
}
],
"customer": { 
"entityType": "Customer",
"firstName": "Jack",
"lastName": "Jones",
"phone": "333-555-5555",
"email": "jack@example.com"
}
}
]
}|
The |
|
|
The parent menu group for a menu item to submit in this order. For example, Salads. |
|
|
The menu item included in this order. For example, Dinner Salad. |
|
|
A modifier group for the Dinner Salad menu item. For example, Salad Dressing. |
|
|
A modifier for the Dinner Salad menu item. For example, Balsamic Vinaigrette. |
|
|
The guest who is placing the order. |
Responses to requests sent to the /orders/{GUID} and
/ordersBulk endpoints contain both the
multiLocationId and guid for all
item, itemGroup, and optionGroup
objects in an order.
The following example response shows how both identifiers are provided for each menu entity.
{
"guid": "2071fb81-988b-4d75-b8dc-c5c17cff9706",
"entityType": "Order",
[contents omitted]
"checks": [
{
"guid": "e4c1f40d-3247-4b8b-9891-52f445930fa3",
"entityType": "Check",
[contents omitted]
"selections": [
{
"guid": "2f91e217-ec31-4659-a7ba-dc66d76a1b5b",
"entityType": "MenuItemSelection",
[contents omitted]
"displayName": "Dinner Salad",
"modifiers": [
{
"guid": "7d850cd0-c014-46f0-bfa6-b1f920c03743",
"entityType": "MenuItemSelection",
[contents omitted]
"optionGroup": {
"guid": "8a2f952d-4dca-4eb0-b867-445f3a674bad",
"entityType": "MenuOptionGroup",
"externalId": null,
"multiLocationId": "100000000171239701"
},
"displayName": "Balsamic Vinaigrette",
[contents omitted]
"item": {
"guid": "e5ccef2d-dc70-4c2d-bddd-d8448dee2e61",
"entityType": "MenuItem",
"externalId": null,
"multiLocationId": "100000000171239909"
},
[contents omitted]
},
],
[contents omitted]
"itemGroup": {
"guid": "c922e206-8512-4d99-a79d-32532eae239f",
"entityType": "MenuGroup",
"externalId": null,
"multiLocationId": "100000000171239911"
},
"item": {
"guid": "50508a61-b561-4a5b-8bbb-7838c045dfab",
"entityType": "MenuItem",
"externalId": null,
"multiLocationId": "100000000437569098"
},
[contents omitted]
},
],
[contents omitted]
},
],
[contents omitted]
}