Glossary - Product Insert
Please note that all the fields marked with ( * ) are required.
| Parameters | Meaning | Type |
|---|---|---|
accountId * required | The customer account ID in Deliverect | string |
locationId * required | The specific customer's location ID in Deliverect | string |
| products | ||
products.productType * required | Specifies the product type being inserted. See section here for productTypes. | integer |
products.plu * required | Unique identifier for a product. It comes from the POS. | string |
products. gtin | GTIN (Global Trade Item Number) for product, which could be EAN code NB: We are not validating these as yet | array of strings |
products.price * required | Defined by a an int with 2 decimal digits. i.e. 5 euros is stored as 500. | integer |
products.name * required | Name for the product | string |
products. visible | This specifies if the item is enabled or disabled within a location | boolean |
products.channelOverrides": {"7": { "visible": false }, "12": { "visible": true } ``` | The channelOverrides allows the visible flag to apply differently per channel (see guide here)Each key represents the ID of a channel (obtained via GET Integrated Channels) | object |
products.posProductId | Internal reference ID for the product coming from the POS. Optional use. | string |
products.posCategoryIds * required | Products should belong at least to one category defined by an array of posCategoryIds. It's important to have at least one category per product. | array of strings |
products.imageUrl | Cloud hosted image URL. See section here for more details | string |
products.description | Product description | string |
products.deliveryTax * required | Tax rate for delivery order, int with 3 decimal digits.See section here for more details. | integer |
products.takeawayTax * required) | Tax rate for pickup order, int with 3 decimal digits. See section here for more details. | integer |
products.eatInTax * required) | Tax rate for pickup order, int with 3 decimal digits. See section here for more details. | integer |
products.multiMax | Defines how many times can the same modifier be chosen. | integer |
products.min * required) | Minimum quantity for a modifier. | integer |
products.max * required) | Maximum quantity for a modifier. | integer |
products.defaultQuantity | Makes a modifier preselected by default. | integer |
isCombo | Indicates product is a combo. | bool |
isVariant | Indicates a product is a variant. | bool |
isVariantGroup | Indicates the group contains variants. | bool |
products.priceLevels | Object containing the posIds specified on the priceLevels array and their corresponding price."priceLevels": { "UE": 900, "DL": 850, "TA": 825 } | object |
| autoApply | ||
autoApply.plu | A predefined set of zero-priced items applied to an order by their PLU. See section here for more details. | string |
sortOrder | Defines the order in which an item will appear when auto-applied. See section here for more details. | integer |
| overloads | Specifies price variances from 'base' price dependant on where option is offered | |
overloads.scopes | Define surcharges applied to the specific modifier group or bundle. See section here for more details. | string |
overloads.price | Determines the price for the overload. See section here for more details. | integer |
overloads.bundlePrice | Determines the price for the overload when the grouping is a bundle. See section here for more details. | integer |
| beverageInfo | ||
beverageInfo.caffeine | Caffeine content (in mg) | integer |
beverageInfo.alcohol | Alcohol content (in % ) | integer |
nutritionalInfo.netQuantity.amount | value of the quantity amount | integer |
nutritionalInfo.netQuantity.countUnitDescription | the unit of the quantity amount | string |
nutritionalInfo.servingSize.amount | the serving size amount | integer |
nutritionalInfo.servingSize.unitType | the unit of the serving size amount | integer |
nutritionalInfo.servingSize.countUnitDescription | the serving size unit | str |
nutritionalInfo"fat""sugar""saturatedFat""carbohydrates""salt""monoUnsaturatedFat""starch""sodium""fiber""vitaminC""calcium""magnesium""chloride""fluoride""potassium""polyols" | The unit of the values is gram. All values listed explained in this section here in more detail. | integer |
calories | kcal / Cals | integer |
caloriesRangeHigh | Where a range of calories applies to a variable option e.g. a 'Sandwich Deal' where selections are required. To apply this, the format would be; • Minimum = calories• Maximum = caloriesRangeHigh | integer |
packaging.reusable | Whether packaging is reusable | bool |
packaging.storageInstructions | How to store an item | string |
packaging.count | integer | |
supplementalInfo.instructionsForUse | Instructions for the use e.g. "Cool before drink." See section here for more information. | string |
supplementalInfo.ingredients | e.g. "Water" | array of strings |
supplementalInfo.fbo.name | Food business operator name | string |
supplementalInfo.fbo.address | Food business operator address | string |
supplementalInfo.fbo.brand | Food business operator brand name | string |
supplementalInfo.fbo.countryOfOrigin | Food business operator country of origin | string |
supplementalInfo.legalName | The legal name of the product | string |
supplementalInfo.additives | e.g. ["Artificial Food Coloring", "PRESERVATIVES_NITRATE"] | array of enums as strings |
supplementalInfo.prepackaged | Indicates if the item is prepackaged. | bool |
supplementalInfo.deposit | Value of the deposit if applicable. | integer |
productTags | e.g.108 = mustard (see guide here) | array of integer |
bottleDepositPrice | Certain regions require deposits to apply for purchases of bottled drinks (see guide here) | integer |
| categories | ||
categories.name * required) | Name for the category. | string |
categories.posCategoryId * required) | Id assigned for the category. | string |
| priceLevels | See section here for more information. This is mandatory when using Price Levels, otherwise, the Price Level will not work. | array of objects |
| priceLevels.name | Name for the priceLevel | string |
| priceLevels.posId | Id for the priceLevel. Value used inside the array products. priceLevels | string |