Übersicht JSON Dateien

Das ioCanto Schema besteht aus verschiedenen Datentypen. Es wird empfohlen die JSON-Files nach Datentypen aufzubereiten und dementsprechend zu benennen.

Wenn Daten importiert und die Files sequenziell, also zu verschiedenen Zeitpunkten geliefert werden, so muss die nachfolgende Reihenfolge der Datentypen eingehalten werden:

PositionDatentyp (Basis für Filename)Pflicht
1product_abstractJa
2product_concreteJa
3product_priceJa
4order_deadlineJa
5delivery_calendarJa
6handling_calendarJa
7customer_invitationJa
8merchant_relationshipJa
9product_restrictionsNein
10product_promotionNein
11product_mediaNein
12on_demand_storageNein
13shopping_listNein
14sales_order_amendmentNein
15sales_order (Hinweis: Nur für Export!)Nein

Datenfiles dürfen auch gleichzeitig übertragen werden. In diesem Fall wird vom System geprüft, welche Files zur Abholung bereit liegen. Danach werden sie automatisch in der richtigen Reihenfolge verarbeitet. Dies gilt sowohl für den Initialimport, wie auch spätere (Delta-)Imports.

Es wird empfohlen, pro Datentyp ein eigenständiges Datenfile zu erstellen. Es ist jedoch praktikabel, die Datentypen customer_invitation und merchant_relationship in einem Datenfile zusammenzufassen.

Namenskonvention

Es gilt:

  • Der Filename muss die Endung .json haben.
  • Der Filename soll idealerweise mit dem spezifischen Datentyp beginnen (Gross- oder Kleinschreibung spielt keine Rolle)
  • Der Filename darf keine Leerzeichen enthalten.
  • Der Filename darf nur aus lateinischen Buchstaben (a-z A-Z), Zahlen (0-9), Bindestrichen (-) und Unterstrichen (_) bestehen.
  • Es wird empfohlen, nebst dem spezifischen Filenamen zumindest eine weitere Klassifizierung mitzugeben, wie z.B. das Aufbereitungsdatum ggf. mit Uhrzeit und - falls ein File kundenspezifisch sein sollte - die Kundenummer oder den Kundennamen. Dabei ist der Datentyp mit der Zusatzklassifizierung durch einen Bindestrich zu trennen.


Beispiel eines korrekten und präferierten Filenamens:

product_abstract-15072024-170103.jsonEnthält nebst dem Filenamen das Datum und Uhrzeit der Aufbereitung.


Beispiele eines unzulässigen Filenamens:

abstract!15072024$.jsonEnthält Leerzeichen und nicht zugelassene Sonderzeichen.
27012023.xlsFalsche Endung, .xls statt .json.


Beispiele eines suboptimalen Filenamens:

27012023.jsonEnthält nicht den spezifischen Datentypen, man weiss nicht, was das File beinhaltet.
product.jsonEnthält zu wenig Informationen zum spezifischen Datentypen, könnte sich um das product_abstract, das product_concrete, den product_price, oder eine Kombination aus allem handeln. Ausserdem fehlt das empfohlene Aufbereitungsdatum inkl. Uhrzeit.
import.jsonEnthält nicht den spezifischen Datentypen, man weiss nicht, was das File beinhaltet. Ausserdem fehlt das empfohlene Aufbereitungsdatum inkl. Uhrzeit.