Glossary - Product Insert
Please note that all the fields marked with * are required.
Parameters | Meaning | Type |
---|---|---|
| The customer account ID in Deliverect | string |
| The specific customer's location ID in Deliverect | string |
products | ||
products. | Specifies the product type being inserted. See section here for productTypes. | integer |
products. | Unique identifier for a product. It comes from the POS. | string |
products. | GTIN (Global Trade Item Number) for product, which could be EAN code
| array of strings |
products. | Defined by a an int with 2 decimal digits. i.e. 5 euros is stored as 500. | integer |
products. | Name for the product | string |
products. | Object containing name translations. See guide here for more information. | Object |
products. | An optional additional name for the product that will be sent through with the order | string |
products. | This specifies if the item is enabled or disabled within a location | boolean |
products. | The Each key represents the ID of a channel (obtained via GET Integrated Channels) For example | object |
products. | Internal reference ID for the product coming from the POS. Optional use. | string |
products. | 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. | Cloud hosted image URL. See section here for more details | string |
products. | Product description | string |
products. | Object containing the translations for the descriptions. See guide here for more details. | object |
products. | Tax rate for delivery order, int with 3 decimal digits.See section here for more details. | integer |
products. | Tax rate for pickup order, int with 3 decimal digits. See section here for more details. | integer |
products. | Tax rate for pickup order, int with 3 decimal digits. See section here for more details. | integer |
products. | Defines how many times can the same modifier be chosen. | integer |
products. | Minimum quantity for a modifier. | integer |
products. | Maximum quantity for a modifier. | integer |
products. | Specifies how many sub products can be ordered at zero value, normal pricing applying after set limit | integer |
products. | Specify a default quantity where '1' is equivalent to a 'pre-selected' item (compatible with only a few channels) | integer |
products. | Indicates product is a combo. | boolean |
products. | Indicates a product is a variant. See section here for more details. | boolean |
products. | Indicates the group contains variants. See section here for more details. | boolean |
products. | Object containing the posIds specified on the
| object |
products. | A product can contain additional options (see full guide here) | array of strings |
autoApply | ||
autoApply. | A predefined set of zero-priced items applied to an order by Deliverect. See section here for more details. | string |
| 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. | Define surcharges applied to the specific modifier group or bundle. See section here for more details. | string |
overloads. | Determines the price for the overload. See section here for more details. | integer |
overloads. | Determines the price for the overload when the grouping is a bundle. See section here for more details. | integer |
beverageInfo | ||
beverageInfo. | Caffeine content (in mg) | integer |
beverageInfo. | Alcohol content (in % ) | integer |
| kcal / Cals | integer |
| 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 = | integer |
packaging. | Whether packaging is reusable | boolean |
packaging. | How to store an item | string |
packaging. | integer | |
| e.g. | array of integer |
categories | ||
categories. | Name for the category. | string |
categories. | Id assigned to the category. | string |
categories. | Image 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 for the price-level | string |
priceLevels. | Id for the price-level.
The value used inside the array products. | string |