| Name | Type | Description | Additional information |
|---|---|---|---|
| ProductID | integer |
Unique identifier for the product. Used to update an existing product. Auto generates if left blank |
None. |
| ProductType | string |
Required. Name of the product type category (e.g., Food, Beverage). |
Required |
| ProductGroup | string |
Required. Name of the product group within the product type. |
Required |
| ProductName | string |
Required. Primary display name of the product. |
Required |
| ProductName2 | string |
Must be provided; blank strings are accepted. Secondary display name of the product (e.g., alternative language). |
Required |
| PriceBand | string |
Required. Name of the price band this product belongs to. |
Required |
| PriceGroup | string |
Required. Name of the price group for pricing rules. |
Required |
| VATRate | string |
Required. VAT rate name applied to this product. |
Required |
| Measure | string |
Required. Name of the measure/portion size (e.g., Each, 330ml). |
Required |
| CostPricePerSKU | decimal number |
Cost price per stock keeping unit. |
None. |
| GrossSellPrice | decimal number |
Required. Gross selling price including VAT. |
Required |
| BarCode | string |
Product barcode. Must be provided; blank strings are accepted. This field can begin with leading zeros. |
Required |
| PLU | string |
Product's PLU number. Must be provided; blank strings are accepted. |
Required |
| PLU2 | string |
Secondary PLU number, mostly used for integrations. Must be provided; blank strings are accepted. |
Required |
| SKUName | string |
Must be provided; blank strings are accepted. Stock Keeping Unit name for inventory tracking. |
Required |
| BINNumber | string |
Must be provided; blank strings are accepted. Bin/location number for stock storage. Supports alphanumeric if enabled. |
Required |
| KPText | string |
Must be provided; blank strings are accepted. Text displayed on kitchen printer tickets. |
Required |
| CommissionPercentage | integer |
Commission percentage awarded for selling this product. |
None. |
| AllowZeroPrice | boolean |
Whether the product can be sold at zero price. |
None. |
| UseStandardVAT | boolean |
Whether to always use standard VAT rate regardless of sales area. |
None. |
| AwardCRMPoints | boolean |
Whether CRM loyalty points are awarded for this product. |
None. |
| ChargePerMinute | boolean |
Whether product is charged per minute (e.g., pool table, gaming). |
None. |
| ExcludeFromReceipt | boolean |
Whether to exclude this product from printed receipts. |
None. |
| PromptForDescription | boolean |
Whether to prompt staff for a description when selling. |
None. |
| SellByWeight | boolean |
Whether product is sold by weight using connected scales. |
None. |
| ServiceChargeExempt | boolean |
Whether product is exempt from service charge. |
None. |
| PrintToKPStandalone | boolean |
Whether to print to kitchen printer as standalone item. |
None. |
| IsMain | boolean |
Whether this is the main course. |
None. |
| ProductInfo | string |
Must be provided; blank strings are accepted. Additional product information or description text. |
Required |
| RezlynxCode | string |
Must be provided; blank strings are accepted. Integration code for PMS systems. |
Required |
| MeasureCostPricePerSKU | decimal number |
Cost price per SKU at the measure level. |
None. |
| ProhibitSalesWhenUnderStocked | boolean |
Whether to block sales when stock level is below set threshold. |
None. |
| IsUseBatchSales | boolean |
Whether product uses batch sales mode for kitchen preparation. |
None. |
| CookTimeSeconds | integer |
Time in seconds required to cook/prepare the product. |
None. |
| ShelfLifeSeconds | integer |
Shelf life in seconds after the product is produced. |
None. |
| IsDisplayAfterProduced | boolean |
Whether to display on KDS after production is complete. |
None. |
| IsBatchSalesProduceOnSale | boolean |
Whether batch sales items are produced immediately on sale. |
None. |
| AlcoholPercent | decimal number |
Alcohol by volume percentage for alcoholic products. |
None. |
| UnitVolume | decimal number |
Volume of the product unit in millilitres. |
None. |
| AllowDiscount | boolean |
Whether discounts can be applied to this product. |
None. |
| ItemCookCount | integer |
Number of items that can be cooked simultaneously. |
None. |
| SelfServiceFood | boolean |
Whether product is available for self-service food ordering. |
None. |
| SelfServiceDrink | boolean |
Whether product is available for self-service drink ordering. |
None. |
| IsChooseLater | boolean |
Whether customer can defer selection (choose later option). |
None. |
| KP1 | boolean |
Whether product is assigned to Kitchen Print Group 1. |
None. |
| KP2 | boolean |
Whether product is assigned to Kitchen Print Group 2. |
None. |
| KP3 | boolean |
Whether product is assigned to Kitchen Print Group 3. |
None. |
| KP4 | boolean |
Whether product is assigned to Kitchen Print Group 4. |
None. |
| KP5 | boolean |
Whether product is assigned to Kitchen Print Group 5. |
None. |
| KP6 | boolean |
Whether product is assigned to Kitchen Print Group 6. |
None. |
| KP7 | boolean |
Whether product is assigned to Kitchen Print Group 7. |
None. |
| KP8 | boolean |
Whether product is assigned to Kitchen Print Group 8. |
None. |
| KP9 | boolean |
Whether product is assigned to Kitchen Print Group 9. |
None. |
| KP10 | boolean |
Whether product is assigned to Kitchen Print Group 10. |
None. |
| KP11 | boolean |
Whether product is assigned to Kitchen Print Group 11. |
None. |
| KP12 | boolean |
Whether product is assigned to Kitchen Print Group 12. |
None. |
| KP13 | boolean |
Whether product is assigned to Kitchen Print Group 13. |
None. |
| KP14 | boolean |
Whether product is assigned to Kitchen Print Group 14. |
None. |
| KP15 | boolean |
Whether product is assigned to Kitchen Print Group 15. |
None. |
| KP16 | boolean |
Whether product is assigned to Kitchen Print Group 16. |
None. |
| HideMeasureShortNameFromReceipt | boolean |
Whether to hide the measure short name from printed receipts. |
None. |
| ThirdPartyCRMPointsValue | integer |
Points value for third-party CRM integrations. |
None. |
| ExtraReceiptText | string |
Must be provided; blank strings are accepted. Additional text to print on receipts for this product. |
Required |
| CRMPointsValue | decimal number |
CRM loyalty points value awarded for this product. |
None. |
| IsAvailableThroughTevalisAPI | boolean |
Whether product is available through the Tevalis API. |
None. |
| IsAlcohol | boolean |
Whether product is classified as alcoholic (for age verification). |
None. |
| CRMCode | string |
Must be provided; blank strings are accepted. CRM integration code for this product. |
Required |
| ReportCategory | string |
Report category name for sales reporting. |
None. |
| Region | string |
Must be provided; blank strings are accepted. Geographic region (typically for wines). |
Required |
| Vintage | string |
Must be provided; blank strings are accepted. Vintage year (typically for wines). |
Required |
| StockWarningLevel | decimal number |
Stock level at which to trigger a low stock warning. |
None. |