Menu Update

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.

Payload

Menu Sample - 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;

Item Identifier
The unique identifier for each item is its plu which should be referenced when creating orders

string
required

The name of the menu.

menuTranslations
object

Translation of the menu name with language codes as keys. Find in the link below all the translatable elements of the menu and the list of translations codes: How to handle translations.

string

Description of the menu.

descriptionTranslations
object

Translation of the menu description with language codes as keys. Find in the link below all the translatable elements of the menu and the list of translations codes: How to handle translations.

string

Header/Banner image url of the menu (more info on images here).

string
required

Internal Deliverect menu id.

string

Only present if a menu has been split into separate versions per order type (e.g. Delivery and Pickup). Provides a stable ID for the original menu, as the menuId of each split version may change.

integer
enum
required

Five different types of menus, with each representing the intended ordering type for which the menu is suitable:

  • DELIVERY_AND_PICKUP = 0
  • DELIVERY = 1
  • PICKUP = 2
  • EAT_IN = 3
  • CURBSIDE = 4

To process menu content when more than one menuType is provided in guide here.

Allowed:
string
required

channelLinkId is an individual store’s unique ID in Deliverect.

boolean
required

Indicates if nested modifiers are present in the menu (see section here for further reference).

integer

See a list of the currency types we will send within a published menu.

productTags
array of integers

Array of all tags that exist in the menu (see guide here).

productTags
availabilities
array of objects

The times during which the menu should be available, which in most cases equate to the Location's opening times. Covered in more detail within the guide here.

availabilities
categories
array of objects

The categories within a menu.

categories
products
object

A 'top level' item on a menu (can also be grouped within a modifier group), sent as "productType": 1.

Object keyed by ID; each key matches the product's _id (e.g. 65********************30).

For more detail on products types and different product configurations follow the link here.

modifiers
object

Options selectable when ordering a product, typically modifications of the product, sent as "productType": 2. Modifiers share a common attribute structure with products (collectively referred to as items below).

Object keyed by ID; each key matches the modifier's _id (e.g. 65********************32).

For more detail on products types and different product configurations follow the link here.

modifierGroups
object

A grouping of modifiers (can also group products), sent as "productType": 3.

Object keyed by ID; each key matches the modifier group's _id (e.g. 65********************31).

For more detail on products types and different product configurations follow the link here.

snoozedProducts
object

PLUs of products and modifiers that are currently snoozed and should be unavailable on the menu.

Object keyed by ID; each key is a unique reference for the snooze object (e.g. 65********************40).

validations
array
deprecated
validations
bundles
object
deprecated

Legacy

Headers
string
required
Defaults to Deliverect/{version}

Identifies Deliverect as the sender of the webhook, in the format Deliverect/{version}.

string
required
Defaults to {signature}

HMAC-SHA256 signature of the raw request body, generated with your shared secret. Recompute the signature on receipt and compare it to this value to verify the request came from Deliverect (see the HMAC authentication guide).

Responses

LoadingLoading…