Purpose
Menus will be routinely published to a provided Menu Update URL. The JSON payload contains all the necessary attributes to display a customer menu(s) as intended
Menu types
All menu types below will be shown as "menuType" and the corresponding integer. This represents the intended ordering format which the menu is suitable for.
| Name | Integer Value |
|---|---|
| Delivery and pickup | 0 |
| Delivery | 1 |
| Pickup | 2 |
| Eat-in | 3 |
| Curbside | 4 |
Product Configurations
Each item in a menu has a specific type as shown in the table below
For more detail on products types and different product configurations follow the link below;
| Product Type | Description | Integer Value |
|---|---|---|
| Product | A 'top level' item on a menu (can also be grouped within a modifier group) | 1 |
| Modifier | Options selectable when ordering a product, typically modifications of the product | 2 |
| Modifier Group | A grouping of modifiers (can also group products) | 3 |
Images
See more information on how various image types are sent within a menu;
Currency
See a list of the currency types we will send within a published menu;
Translations
Find in the link below all the translatable elements of the menu and the list of translations codes.
Store Opening Times
A Location's opening times are communicated within the menu payload as "availabilities" and covered in more detail within the guide below;
Product Availability
There are two indicators of a product availability which are it's "snoozed" state and "visible" status. These are detailed in the page below;
Multiple menus per fulfillment type
Check out the guide below that details handling menu content when more than one menu is received;
Sample Menu JSON
Follow the guide How to recieve menus to create and publish a test menu to your channel from your Deliverect test account. See full JSON sample below;