Glossary - Menus

ParametersMeaningType
Availabilities
dayOfWeekAn integer value that indicates the day of the week for this availability (starting at 1 for Monday).int
endTimeA 24-hour HH:MM format notation of the start time of an availability.int
startTimeA 24-hour HH:MM format notation of the end time of an availability.int
Categories
_idinternal Deliverect id of the categorystring
namename of menu categorystring
description description of menu categorystring
descriptionTranslationstranslations of the category namestring
nameTranslationstranslations of the category namestring
accountaccountId of the merchant in Deliverectstring
posLocationIdinternal POS location id, legacy parameter not relevant for the channel integrationstring
posCategoryTypelegacy parameter, not relevant for the channel integrationsstring
posCategoryIdindicates the POS ID for this particular category, when the POS has multiple same-name categories, this ID makes a difference between themstring
imageUrlimage url of the category, currently not availablestring
subCategoriescategories under main category, currently not available string
productsholds a list of products or product IDs that belong to this categorystring
availabilitiescategory availabilitiesdate
levellegacy parameter, not relevant for the integrationint
menuthe internal Deliverect ID of the menu this category belongs tostring
subProductsproducts that exist under each categorystring
subProductSortOrdera list of product PLUs belonging to this category that preserves the order of these productsstring
Menu
channelLinkIdthe id for the channelLink that this menu is published tostring
currencycurrency of the menustring
descriptiondescription of the menustring
descriptionTranslationstranslation of the description of the menu categorystring
menuthe menu namestring
menuIdinternal Deliverect menu id string
menuImageUrlimage url of the menustring
menuTypeFive 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
int
nestedModifiersa boolean on a menu to indicate that the modifiers in this menu could have modifiers on their ownboolean
Items
_idinternal Deliverect ID of the itemstring
nameitem namestring
descriptionitem descriptionstring
descriptionTranslationstranslation of item descriptionstring
nameTranslationstranslation of item namestring
accountaccount id of the merchant in Deliverectstring
capacityUsageslegacy parameter, not relevant for the channel integrationstring
deliveryTaxsales tax specific on order type for the itemint
eatInTaxsales tax specific on order type for the itemint
takeawayTaxsales tax specific on order type for the item
locationlocation id of the merchant in Deliverectstring
maxmaximum number of items under a group to be purchasedint
minminimum number of items under a group to be purchasedint
multiMaxmaximun number of same item to be purchasedint
multiplymultiply is used in bundles to show this product multiple times in the GUI, 1 means one entry (so no copies)int
pluunique identifier of the item, to be used when creating ordersstring
posCategoryIdsthe POS ID of the category this product belongs to in the POSstring
posProductCategoryIdthe ID of this product in the POS, internal to POS, not to be used when creating ordersstring
productTagsitem allergiesint
posProductIdthe ID of this product in the POS, internal to POS, not to be used when creating ordersstring
productTypetype of item ie. product, modifier group, modifier, bundleint
subProductsproducts that exist under each productstring
visibleboolean that signifies that a product is visible in the menu, legacy parameter not relevant for the channel integration, the value will always be set to "true"boolean
parentIdthe internal Deliverect ID of the channel product that the current product belongs to, legacy parameter, use the subProducts parameter to define which items exist under each productstring
snoozeda boolean indicating whether this product is snoozed boolean
subProductSortOrdera list of product PLUs belonging to this product that preserves the order of these sub-Productsstring
priceprice of the itemint
snoozedProductsPLUs of products and modifiers that are currently snoozed and should be unavailable on the menustring
instructionsForUseinstructions for use of the productstring
ingredientslist of strings of ingredientsstring
additiveslist of strings of additivesstring
prepackagedif item is prepackaged or notboolean
nutritionalInfonutritional information in grams, i.e fat, carbohydrates, sugar, saturatated fat, protein, saltint