Glossary - Menus

Parameters

Meaning

Type

menu *

The name of the menu

string

menuTranslations

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

object of strings

description

description of the menu

string

descriptionTranslations

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

object of strings

menuImageURL

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

string

menuId *

internal Deliverect menu id

string

menuType *

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

integer

channelLinkId *

the id for the channelLink that this menu is published to

string

nestedModifiers *

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

boolean

currency

currency of the menu

interger

productTags

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

array of integers

availabilities

The times during which the menu should be available. This will in most cases equate to the store's opening hours.

array of objects

availabilities.dayOfWeek

An integer value that indicates the day of the week for this availability (starting at 1 for Monday).

integer

availabilities.startTime

A 24-hour HH:MM format notation of the start time of availability expressed in the local time of the location.

string

availabilities.endTime

A 24-hour HH:MM format notation of the end time of availability expressed in the local time of the location.

string

categories

The categories within a menu

array of objects

categories._id

internal Deliverect id of the category

string

categories.name

category name

string

categories.nameTranslations

translations of the category name with language codes as keys (see guide here)

object of strings

categories.description

description of the category

string

categories.descriptionTranslations

translation of the category description with language codes as keys (see guide here)

object of strings

categories.imageUrl

image url of the category (see more info on images here)

string

categories.availabilities

category availabilities

array of objects

categories.availabilities.dayOfWeek

An integer value that indicates the day of the week for this categories availability (starting at 1 for Monday).

integer

categories.availabilities.startTime

A 24-hour HH:MM format notation of the start time of availability expressed in the local time of the location.

string

categories.availabilities.endTime

A 24-hour HH:MM format notation of the start time of availability expressed in the local time of the location.

string

categories.availabilities.category

Unique ID of the menu category

string

categories.subProducts

products that exist under each category, see guide here for more context on correct sorting

string

categories.menu

the unique ID of the menu this category belongs to

string

categories.account

the unique ID of the account this category belongs to

string

categories.posLocationId

LEGACY PARAMETER

categories.products

LEGACY PARAMETER for correct sorting of products in categories, see subProducts

array of strings

categories.posCategoryType

LEGACY PARAMETER

string

categories.posCategoryId

LEGACY PARAMETER

array of strings

categories.subCategories

LEGACY PARAMETER

array of strings

categories.sortedChannelProductIds

LEGACY PARAMETERfor correct sorting of products in categories seesubProducts

array of strings

categories.subProductSortOrder

LEGACY PARAMETERfor correct sorting of products in categories, see subProducts

string

categories.level

LEGACY PARAMETER

integer

products / modifiers modifierGroups

array of objects

Identifier of a particular item and it's location in the menu structure.

string

Unique identifier of the item, to be used when creating orders

string

GTIN (Global Trade Item Number) for product, which could be EAN code NB: We are not validating these as yet

array of strings

Image associated with the item (see more info on images here)

string

Item name

string

Price of the item with 2 decimal digits. e.g. 1 euro is stored as 100.

integer

LEGACY PARAMETER (see supplementalInfo.deposit)

integer

translation of an item name with language codes as keys (see guide here)

string

PRODUCT = 1 MODIFIER = 2 MODIFIER GROUP = 3

integer

item description

string

translation of the item description with language codes as keys (see guide here)

string

sales tax specific on order type of 'Delivery' for the item. Tax rates are always stored as an int with 3 decimal digits e.g. 5% would be sent as 5000

integer

sales tax specific on order type of 'Takeaway' for the item. Tax rates are always sent as an int with 3 decimal digits e.g. 5% would be sent as 5000

integer

sales tax specific on order type of 'Eat-in' for the item. Tax rates are always sent as an int with 3 decimal digits e.g. 5% would be sent as 5000

integer

maximum number of items under a group to be purchased

integer

minimum number of items under a group to be purchased

integer

maximum quantity of any single item which can be purchased within a group (modifier group)

Also applicable to Products where it should control how many items can be added to a basket e.g. Paracetamol

integer

this controls the behaviour of 'pre-selected' items, where a quantity >0 should be automatically selected (typically '1') higher default quantities can also be set

integer

multiply is used in Modifier Group to show this product multiple times in the GUI, 1 means one entry (so no copies)

integer

This flag indicates if a product is a combo item/meal deal

boolean

Applicable to a product to indicate if it is a variant or not (see guide here)

boolean

Applicable to a modifier group to indicate if it is a variant or not (see guide here )

boolean

snoozed *

Indicates whether an item is snoozed at the point of a menu being published

boolean

LEGACY PARAMETER (the value will always be set to "true")

boolean

All tags which apply to this item, see complete list here

integer

Unique customer account ID where the item is stored

string

the original PLU of the item, only for tracking sales e.g. for loyalty purposes. Not to be included in the payload for order creation.

string

Unique customer location ID where the item is stored

string

LEGACY PARAMETER

string

Indicates if the modifier group is an Upsell group

boolean

list of items belonging to the group

array

information specific to beverages

object

expressed in mg

integer

expressed in mg

integer

expressed in kcal / Cals

integer

if a range is supported, the minimum would be "calories" and maximum"caloriesRangeHigh"

integer

Expressed in grams e.g. fat, sugar, saturatedFat, carbohydrates, protein, saltetc (see this section of product guide here)

integer

details of a serving size

nested object

the serving size amount

integer

What the serving size unit type is; Weight = 1 Volume = 2 Count = 3

integer

the serving size unit description

string

details on quantity

nested object

the net quantity amount

integer

What the net quantity unit type is; Weight = 1 Volume = 2 Count = 3

integer

the net quantity unit description

details on the packaging

object

quantity of packaging

integer

whether packaging is re-usable or not

boolean

instructions for storage

string

additional information about an item, for more information see here

object

legal name of the item

string

any specific instructions for use

string

array of ingredients

nested array of strings

array of ingredients

nested array of strings

specifies whether the item is prepackaged

boolean

In certain regions a deposit is required for e.g. bottled drinks

this will be included in the price, yet the deposit should be clearly displayed to the consumer

Deposit expressed to 2 decimal digits. e.g. 1 euro is stored as 100 (see guide here )

integer

Details of the food business operator

nested object strings

Food business operator name

nested object strings

Food business operator address

string

Food business operator brand name

string

Food business operator country of origin

string

LEGACY PARAMETER (use the subProducts parameter to understand item relationships)

string

the POS ID of the category this product belongs to in the POS

string

the ID of this product in the POS, internal to POS, not to be used when creating orders

string

the ID of this product in the POS, internal to POS, not to be used when creating orders

string

a list of product PLUs belonging to this product that preserves the order of these sub-Products

string

items_.displayLabels

a list of labels added to the products

array of strings

snoozedProducts

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

nested objects

snoozedProducts.{snoozeKey}

a unique reference for the snooze object in format "65********************1d"

object

snoozedProducts.location

Deliverect location ID where the item is snoozed

string

snoozedProducts.name

Item name

string

snoozedProducts.plu

Item reference

string

snoozedProducts.snoozeStart

Timestamp in UTC when snooze begins yyyy-MM-dd HH:mm:ss.SSSSSSZ

string

snoozedProducts.snoozeEnd

Timestamp in UTC when snooze ends yyyy-MM-dd HH:mm:ss.SSSSSSZ

string

validations

LEGACY PARAMETER

array