Item List Upload Format

The item list editor can update the items accepted by the cash register from an uploaded JSON file. The upload must contain a configuration object with an items array. Uploaded items are matched by number; existing items with the same number are updated and items with new numbers are added.

::: note Where to use this: Admin → Item list editor → Update using file. :::

Minimum File

The smallest useful file contains items and paymentTypes. Keep paymentTypes as an empty object when you only want to update items.

{
  "items": [
    {
      "number": 101,
      "name": "Tomato Soup",
      "description": "Tomato soup with basil",
      "price": 6.5,
      "itemState": "ACTIVE",
      "itemType": "Food",
      "priceTogo": 6.5,
      "category": {
        "name": "Starters"
      },
      "numberOfItems": 1,
      "image": "",
      "characteristics": [
        "VEGETARIAN"
      ],
      "combinationItems": [],
      "maximumCombinationItems": 0,
      "validCustomerTypeNumbers": [],
      "customerTypeRestriction": []
    }
  ],
  "paymentTypes": {}
}

Item Fields

Field	Required	Description
number	Yes	Numeric item identifier from the cash register. This is used to decide whether an item is updated or added.
name	No	Name shown for the item.
description	No	Description shown on the menu.
price	No	Decimal price, using a dot as the decimal separator.
itemState	No	Use ACTIVE for items that should be available.
itemType	No	One of Menu item, Food, Takeout, Condiments, Beverages, Unknown, or Arrangement.
category	No	Category object. At minimum, provide {"name": "Category name"}.
characteristics	No	Array of labels such as VEGETARIAN, VEGAN, or allergen codes like ALLERGEN_GLUTEN.
combinationItems	No	Array of selectable combination items. Use an empty array when the item has no combinations.
validCustomerTypeNumbers	No	Array of customer type numbers that can order this item. Use an empty array when there is no restriction.
printerGroup	No	Logical printer group name, for example KITCHEN, BAR, or TICKET.

Accepted Input

The upload accepts a JSON configuration export in the same structure shown above. The backend also attempts to convert supported cash-register export formats before merging the items.

WARNING

Important: The upload does not replace the whole configuration when a configuration already exists. It merges the uploaded item list into the existing configuration and updates payment types from the uploaded file.