Upload-Format für Artikel

Der Artikellisten-Editor kann die von der Kasse akzeptierten Artikel aus einer hochgeladenen JSON-Datei aktualisieren. Der Upload muss ein Konfigurationsobjekt mit einem items-Array enthalten. Hochgeladene Artikel werden anhand der number zugeordnet; vorhandene Artikel mit derselben Nummer werden aktualisiert und Artikel mit neuen Nummern werden hinzugefügt.

::: note Verwendung: Admin → Artikellisten-Editor → Mittels Datei aktualisieren. :::

Minimale Datei

Die kleinste sinnvolle Datei enthält items und paymentTypes. Lassen Sie paymentTypes als leeres Objekt, wenn Sie nur Artikel aktualisieren möchten.

{
  "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": {}
}

Artikelfelder

Feld	Erforderlich	Beschreibung
number	Ja	Numerische Artikelkennung von der Kasse. Wird verwendet, um zu entscheiden, ob ein Artikel aktualisiert oder hinzugefügt wird.
name	Nein	Name, der für den Artikel angezeigt wird.
description	Nein	Beschreibung, die im Menü angezeigt wird.
price	Nein	Dezimalpreis, mit Punkt als Dezimaltrennzeichen.
itemState	Nein	Verwenden Sie ACTIVE für Artikel, die verfügbar sein sollen.
itemType	Nein	Einer von Menu item, Food, Takeout, Condiments, Beverages, Unknown oder Arrangement.
category	Nein	Kategorieobjekt. Mindestens {"name": "Category name"} angeben.
characteristics	Nein	Array von Bezeichnungen wie VEGETARIAN, VEGAN oder Allergencodes wie ALLERGEN_GLUTEN.
combinationItems	Nein	Array von auswählbaren Kombinationsartikeln. Bei Artikeln ohne Kombinationen ein leeres Array verwenden.
validCustomerTypeNumbers	Nein	Array von Kundentypnummern, die diesen Artikel bestellen können. Bei keiner Einschränkung ein leeres Array verwenden.
printerGroup	Nein	Name der logischen Druckergruppe, z.B. KITCHEN, BAR oder TICKET.

Akzeptierte Eingabe

Der Upload akzeptiert einen JSON-Konfigurationsexport in derselben Struktur wie oben gezeigt. Das Backend versucht außerdem, unterstützte Kassencxportformate zu konvertieren, bevor die Artikel zusammengeführt werden.

WARNING

Wichtig: Der Upload ersetzt nicht die gesamte Konfiguration, wenn bereits eine Konfiguration existiert. Er führt die hochgeladene Artikelliste mit der vorhandenen Konfiguration zusammen und aktualisiert die Zahlungsarten aus der hochgeladenen Datei.