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. :::

WARNING

Choose the import mode deliberately: Update updates matching item numbers and adds new ones while retaining other existing items. Replace also removes items absent from the uploaded list and removes those item placements from menu pages. Both update the payment types from the input; this is not a whole-configuration import.

Update or replace

1. Save a configuration version before a large import.
2. Open Configurations → Edit items → Update using file.
3. Select the JSON file and choose Update or Replace.
4. Read and confirm the replacement warning when replacing.
5. Review the import summary: provided, new, updated, and (for Replace) removed items. Expand the sections to inspect affected numbers.
6. Check menu pages afterward, especially placements of removed items.

Replacement can remove items even when the input is a small partial list. Use Update for a partial change. If an import was unintended, use the configuration history to recover a known version.

Minimum File

The example below shows the file structure. Replace the sample items and supply the payment types required by your installation. An empty paymentTypes object replaces existing payment types with an empty mapping, including in Update mode. Save a configuration version before importing.

{
  "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, Arrangement, or Sub item.
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.