HomeGuidesAPI DocumentationAPI UpdatesAsk a QuestionStatus Page

Commerce Menus - Model

Please note that all the fields marked with ( * ) will always be present in the response payload.

ParametersMeaningType
menu * The name of the menustring
menuTranslationstranslation of the menu name with language codes as keys (see guide here)object of strings
descriptiondescription of the menustring
descriptionTranslationstranslation of the menu description with language codes as keys (see guide here)object of strings
menuImageUrlHeader/Banner image url of the menu (more info on images here)string
menuId * internal Deliverect menu idstring
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
nestedModifiers * Indicates that nested modifiers are present in the menuboolean
currencycurrency of the menuinteger
productTagsArray of all tags that exist in the menu (see guide here)array of integers
categoriesThe categories within a menuarray of objects
categories.idinternal Deliverect id of the categorystring
categories.namecategory namestring
categories.nameTranslationstranslations of the category name with language codes as keys (see guide here)object of strings
categories.descriptiondescription of the categorystring
categories.descriptionTranslationstranslation of the category description with language codes as keys (see guide here)object of strings
categories.imageUrlimage url of the category (see more info on images here)string
categories.subProductsproducts that exist under each category, see guide here for more context on correct sortingarray of string
categories.menuthe unique ID of the menu this category belongs tostring
categories.accountthe unique ID of the account this category belongs tostring
products / modifiers
modifierGroups / bundles
  • Seperate keys for "products", "modifiers", modifierGroups and bundles exist, they share many attributes as listed below and for documentation purposes, are referred to as items
array of objects
items_.id * Identifier of a particular item and it's location in the menu structure.string
items_.plu * Unique identifier of the item, to be used when creating ordersstring
items_.name * Item namestring
items_.nameTranslationstranslation of an item name with language codes as keys (see guide here)string
items_.productType * PRODUCT = 1
MODIFIER = 2
MODIFIER GROUP = 3
BUNDLE = 4		integer
items_.descriptionitem descriptionstring
items_.descriptionTranslationstranslation of the item description with language codes as keys (see guide here)string
items_.max * maximum number of items under a group to be purchasedinteger
items_.min * minimum number of items under a group to be purchasedinteger
items_.defaultQuantitythis controls the behaviour of 'pre-selected' items, where a quantity >0 should be automatically selected (typically '1') higher default quantities can also be setinteger
items_.multiply * multiply is used in bundles to show this product multiple times in the GUI, 1 means one entry (so no copies)integer
items_.isVariantApplicable to a product to indicate if it is a variant or not (see guide here)boolean
items_.productTagsAll tags which apply to this item, see complete list hereinteger
items_.accountUnique customer account ID where the item is storedstring
items_.referenceIdthe 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
items_.subProductslist of items belonging to the grouparray of string
items_.beverageInfoinformation specific to beveragesobject
items_.beverageInfo.caffeineexpressed in mginteger
items_.beverageInfo.alcoholexpressed in mginteger
items_.caloriesexpressed in kcal / Calsinteger
items_.caloriesRangeHighif a range is supported, the minimum would be "calories" and maximum"caloriesRangeHigh"integer
items_.nutritionalInfoExpressed in grams e.g. fat, sugar, saturatedFat, carbohydrates, protein, saltetc (see this section of product guide here)integer
items_.nutritionalInfo.servingSizedetails of a serving sizenested object
items_.nutritionalInfo.servingSize.amountthe serving size amountinteger
items_.nutritionalInfo.servingSize.unitTypeWhat the serving size unit type is;
Weight = 1

Volume = 2
Count = 3		integer
items_.nutritionalInfo.servingSize.countUnitDescriptionthe serving size unit descriptionstring
items_.nutritionalInfo.netQuantitydetails on quantitynested object
items_.nutritionalInfo.netQuantity.amountthe net quantity amountinteger
items_.nutritionalInfo.netQuantity.unitTypeWhat the net quantity unit type is;
Weight = 1

Volume = 2
Count = 3		integer
items_.nutritionalInfo.netQuantity.countUnitDescriptionthe net quantity unit description
items_.packagingdetails on the packagingobject
items_.packaging.countquantity of packaginginteger
items_.packaging.reusablewhether packaging is re-usable or notboolean
items_.packaging.storageInstructionsinstructions for storagestring
items_.supplementalInfoadditional information about an itemobject
items_.supplementalInfo.legalNamelegal name of the itemstring
items_.supplementalInfo.instructionsForUseany specific instructions for usestring
items_.supplementalInfo.ingredientsarray of ingredientsnested array of strings
items_.supplementalInfo.additivesarray of ingredientsnested array of strings
items_.supplementalInfo.prepackagedspecifies whether the item is prepackagedboolean
items_.supplementalInfo.depositany specific deposit that appliesinteger
items_.supplementalInfo.fboDetails of the food business operatornested object strings
items_.supplementalInfo.fbo.nameFood business operator namenested object strings
items_.supplementalInfo.fbo.addressFood business operator addressstring
items_.supplementalInfo.fbo.brandFood business operator brand namestring
items_.supplementalInfo.fbo.countryOfOriginFood business operator country of originstring
items_.subProductSortOrdera list of product PLUs belonging to this product that preserves the order of these sub-Productsarray of string