ioCanto Schema

Unter dem nachfolgenden Link kann das ioCanto-Schema eingesehen werden, wo sämtliche Daten spezifiziert sind: ioCanto Spec in gitlab.

Zu jedem Datentyp gibt es zudem ein Beispiel, wo man einsehen kann, wie das jeweilige Ergebnis aussehen kann: Beispiele in gitlab.

Aufbau ioCanto Schema

Das Schema ist in zwei Haupt-Bereiche gegliedert: Definitionen und Properties. Diese werden nachfolgend etwas näher beleuchtet:

Definitionen

Hierunter fallen allgemein gültige Definitionen zu Typen von Feldern oder auch die Listung der Wertbereiche zu Feldern, wo die Auswahl vorgegeben ist. Beispiele dazu sind:

Aufbau der Gebührenlogik.
Erlaubte Zeichen für die Artikelnummer.
Multiplizieren der Preisangaben oder Prozentwerte mit dem Faktor 100‘000.

Zu den Wertebereichen gehören beispielsweise:

Ländercodes
Rechtsform
Verfügbarkeitsstatus
Verpackungseinheiten
Masseinheiten

Properties

Die Properties stellen die Datentypen innerhalb von Mercanto dar und beinhalten den detaillierten Aufbau der Datentypen, wie Typ, Beschreibungen oder Pflichtfelder.

Strukturierung der Daten

Die Felder sind genau einem Datentyp zugewiesen. Hierbei ist der Grundaufbau wie folgt:

Ebene 1	Datentyp	Bsp: `product_abstract`, `order_deadline_time`
Ebene 2	Datenobjekt	Bsp: `catalog`, `price_group`
Ebene 3	Feld	Bsp: `base_measurement_code`, `no_public_price`

Datenobjekte werden immer dann verwendet, wenn es mehrere zusammengehörende und/oder abhängige Felder gibt. Beispiel warehousing: Hierzu gibt es die Felder type, environment und shelf_life_days.

Am Ende jedes Datentyps wird angegeben, welche Felder Pflichtfelder sind.

Kategorisierung der Datenfelder

Im Minimum wird zu jedem Feld ausgegeben:

`key`	Eindeutiger Schlüssel des Feldes
`type`	Typ des Feldes, kann `string`, `integer`, `number`, `object` oder `array` sein

Optional können weitere Informationen enthalten sein wie:

`title`	Titel des Feldes.
`description`	(Weiterführende) Beschreibung zum Feld und für was es gedacht ist.
`$ref`	Referenz zu den Definitionen.
`minimum`	Kleinster zulässiger Input für das Feld.
`maximum`	Grösster zulässiger Input für das Feld.
`maxLength`	Maximal zulässige Länge des Feldes.
`enum`	Zulässiger Wertebereich für das Feld.
`default`	Standardwert, wenn nichts geliefert wird.

Fileinhalte zur Identifizierung

Jedes JSON-File muss nebst den spezifischen Feldern die folgenden fileübergreifenden Felder am Anfang enthalten:

merchant: Hier muss der definierte key, welcher bei Anlage des Lieferanten vergeben wurde, mitgegeben werden.
version: Die aktuelle Versionsnummer kann beim Mercanto Onboarding Team angefragt werden.

Sprachabhängige Felder

Beim Erstellen des Lieferanten in Mercanto wurde eine von Ihnen gewünschte Sprache als Standardsprache hinterlegt. Beim Import von sprachabhängigen Inhalten muss in Feldern, die in ioCanto mit localized_text definiert sind, mindestens die Standardsprache geliefert werden. Des Weiteren wurde hinterlegt, welche Sprachen Sie als Lieferant unterstützen. Für diese unterstützten Sprachen können Sie Übersetzungen im entsprechenden locale (de_CH, fr_CH, it_CH, en_GB) liefern. Hinweis: Alle von Ihnen nicht unterstützten Sprachen werden automatisch mit dem Inhalt der Standardsprache überschrieben.