Menu Update

Body Params
string

The name of the menu. Always present.

menuTranslations
object

Translation of the menu name with language codes as keys (see guide here).

string

Description of the menu.

descriptionTranslations
object

Translation of the menu description with language codes as keys (see guide here).

string

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

string

Internal Deliverect menu id. Always present.

integer
enum

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. Always present.

Allowed:
string

The id for the channelLink that this menu is published to. Always present.

boolean

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

integer

Currency of the 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. This will in most cases equate to the store's opening hours.

availabilities
categories
array of objects

The categories within a menu.

categories
products
object

Keyed object of products, sharing a common structure with modifiers and modifierGroups (collectively referred to as items in this schema's descriptions). Keyed by product _id.

modifiers
object

Keyed object of modifiers, sharing a common structure with products and modifierGroups (collectively referred to as items in this schema's descriptions). Keyed by modifier _id.

modifierGroups
object

Keyed object of modifier groups, sharing a common structure with products and modifiers (collectively referred to as items in this schema's descriptions). Keyed by modifier group _id.

snoozedProducts
object

PLUs of products and modifiers that are currently snoozed and should be unavailable on the menu, keyed by a unique snooze reference.

validations
array
deprecated

Legacy attribute. Not to be referenced as part of an integration.

validations
bundles
object
deprecated

Legacy attribute. Bundle configuration for the menu. Not documented in the menu parameters glossary; observed as an object in the menu update payload example. Shape unconfirmed — treat as an opaque object until documented.

Headers
string
Defaults to Deliverect/{version}

Deliverect/{version}

string
Defaults to {signature}

{signature}

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json