Datenformate und Ausgabeformate

Übersicht

Der Umfang der von Exporten und der API auszugebenden Daten ist für jede Kombination Datenformat und Ausgabeformat identisch. D.h. egal welches Ausgabeformat ausgewählt ist, der Inhalt der Daten im Datenformat ist immer identisch.

Es gilt jedoch ein Vertragsabhängiges Limit pro Export für alle Kombinationen aus Datenformat und Ausgabeformat.

Folgende Formattypen sind zulässig und benutzen die angegebenen Formatkennzeichner. Das xsd Schema der verfügbaren Ausgabeformate kann über die info Methode abgerufen werden.

Datenformat / Ausgabeformat	csv	json	xml	Anwendungsbereich	Sprache
standard*	x	x	x	Produkte und Produktsuche	einsprachig
standardUpdate	x	x	x	Produkte und Produktsuche	einsprachig
developer**	x	x	x	Produkte und Produktsuche	bis zu 6
developerUpdate	x	x	x	Produkte und Produktsuche	einsprachig
deal		x	x	Bestellungen	Deutsch
quote		x	x	Angebote	Deutsch
company		x	x	Hersteller und Lieferanten	Deutsch
producttype		x	x	Kategorien	Deutsch
ORDER, ORDERRESPONSE, DISPATCHNOTIFICATION, INVOICE			x	OpenTrans 2.1 Bestellung Dokumente	Deutsch
QUOTE			x	OpenTrans 2.1 Angebot Dokumente	Deutsch

* von ITscope empfohlenes Profil, das fast alle Anwendungsgebiete abdeckt werden

** nur empfehlenswert für Profis, die sich mit der ITscope Datenstruktur auskennen. Wird nur empfohlen mit einer technischen Beratung durch ITscope.

Datenformate für Artikelanlagen

standard

Dieses Profil wird zu Abdeckung von fast allen Anbindungen von ITscope empfohlen. Dieser Typ enthält nur ausgewählte Daten, die darauf ausgelegt sind für die meisten Zwecke auszureichen, ohne zu viel Datenvolumen zu erzeugen. Die Daten in dem Profil sind aggregiert, d.h. alles ist für den sofortigen Einsatz bereits vorausgefüllt. Ids, Bilder, Texte, Keys, Preise, technische Eigenschaften.

Diese Profil stellt die Daten in einfach nutzbarer Form bereit – als flache CSV-Dateien, oder im XML, oder im JSON Format mit Produkt-, Lieferanten-, Eigenschafts- und Cross-Selling-Daten.

Diese Profil wird für den täglichen Abgleich empfohlen.

developer

Sämtliche in der ITscope Plattform zu einem Produkt verfügbaren Daten werden ausgegeben, inklusive kompletter Content. Diese Profil ist wirklich nur was für Profis, Anwender die sich mit der kompletten Struktur der ITscope Daten auskennen und bereit sind diese auch zu lernen.

Wir empfehlen hier immer auf eine technische Beratung von ITscope zurückzugreifen. Durch eine entsprechenden Einführung in die Datenstruktur und Bedeutung der jeweiligen Datenobjekte direkt auf Ihre Bedürfnisse wird unnötiger Aufwand eingespart.

Tabellarische Formate liegen bei diesem Datentyp als eine einzige Tabelle vor. Bei relevanten 1:1-Beziehungen wurde der referenzierte Satz in die Tabelle eingebunden. Für jede 1:n-Beziehung wurde eine Anzahl der Referenzen festgelegt, die eingebunden werden sollen. Dabei wird immer die gleiche Anzahl von Feldern in der Gesamttabelle verwendet. Liegen von vier konfigurierten Referenzen nur drei vor, werden die Feldeinträge für alle vier erzeugt, bleiben jedoch für den fehlenden vierten Satz leer. Bei sich wiederholenden Feldern werden die Feldnamen mit einem Zähler durchnummeriert.

Dieses Profil wird für den täglichen Abgleich empfohlen.

Datenformate für Artikelaktualisierungen

standardUpdate

Das update Profil passt immer zu seinem Hauptprofil und liefert nur Bewegungsdaten zum Updaten, wie Preise, Lagerbestände, Liefertermine. Das Datenvolumen ist geringer als der Hauptprofil und wird meistens dazu verwendet um die Bewegungsdaten des Zielsystems aktuell zu halten.

Dieses Profile kann zum effizienten stündlichen Abgleich von Preisen und Verfügbarkeiten genutzt werden.

developerUpdate

Das update Profil passt immer zu seinem Hauptprofil und liefert nur Bewegungsdaten zum Updaten, wie Preise, Lagerbestände, Liefertermine. Das Datenvolumen ist geringer als der Hauptprofil und wird meistens dazu verwendet um die Bewegungsdaten des Zielsystems aktuell zu halten.

Dieses Profile kann zum effizienten stündlichen Abgleich von Preisen und Verfügbarkeiten genutzt werden.

Ausgabeformat Eigenschaften

Die von Exporten und der API ausgegebenen Daten können in folgenden Formaten geschrieben werden.

• Tabellarisches Format: CSV
• Hierarchische Format: XML, JSON

Allgemeine Eigenschaften für alle Ausgabeformate

• keine Carriage Returns (CR) oder Linefeeds (LF) innerhalb von Spalten oder Elementen
• alle Daten sind UTF-8 kodiert

Die Reihenfolge der Inhalte in allen Formaten (CSV, JSON, XML) sind übersichtlich gruppiert in folgende Kategorien:

• Identifikatoren & IDs, z.B. PUID, EAN, icecatID
• Produktbeschreibung und Name
• Bezugsquellen
• Kategorisierung und Attribute
• Dimensionen
• Links und Bilder
• Preise und Lagerbestände
• HTML-Datenblattdaten und Marketingtexte
  

Ausgabeformat CSV

Dieser Datentyp bedingt, dass tabellarische Formate mehr als eine Tabelle enthalten, weil Objekte einander referenzieren. Solche Formate haben immer eine eindeutige Kennung für jeden Satz und referenzieren diese Kennungen aus damit verknüpften Sätzen.

Das CSV-Format ist ein tabellarisches Format, das von ITscope wie folgt geschrieben wird:

• Daten sind immer komprimiert und werden als ZIP Paket zur Verfügung gestellt
• Datensätze werden durch Zeilenumbrüche (CRLF) getrennt.
• Felder werden durch Tabulator (\t) getrennt.
• Die erste Zeile besteht aus den Feldnamen, ebenfalls durch Tabulator (\t) getrennt.
• Zeichenketten haben kein Quoting, d.h. kein Quoting der einzelnen Spalten durch HOCHKOMMA („)
• Innerhalb von Zeichenketten tauchen weder Tabulatoren, noch Zeilenumbrüche auf.
• Fließkommazahlen enthalten einen Dezimalpunkt und kein Tausendertrennzeichen.
• Datumswerte liegen als „dd.MM.yyyy hh:mm“ vor, wie in „12.05.2013 08:02“.
• CSV-Dateien sind UTF-8-kodiert.

CSV-Downloads werden grundsätzlich als ZIP-Datei komprimiert ausgeliefert. Multi-File CSV-Formate enthalten im ZIP-Archiv mehrere CSV-Dateien, die einander referenzieren. Auch in Fällen wo nur eine einzige Datei als Ergebnis geliefert wird, kann das ZIP-Archiv mehrere Dateien enthalten.

• log.csv: enthält eine Liste der Produkte, die herausgefiltert wurden und der Grund für diese Filterung – diese Informationen sind für den ITscope Support gedacht, um bei Problemen besser recherchieren zu können.
• ERROR.txt: ist vorhanden, wenn Fehler aufgetreten sind; in einem fehlerfreien Export ist die Datei nicht enthalten; ist die Datei vorhanden aber leer konnte der Grund nicht ermittelt werden.
  

Ausgabeformat XML

Hierarchische Formate enthalten sämtliche Informationen, die entsprechenden Objekte sind jedoch untergeordnet zum referenzierenden Objekt in das übergeordnete eingebettet.

 
XML ist ein hierarchisches Format, in welchem ein übergeordnetes Objekt untergeordnete Objekte einbettet.

Die Feldnamen werden als Namen für die XML-Elemente verwendet. Referenzierte Objekte wurden bereits aufgelöst und sind direkt im übergeordneten Element eingebunden.

XML-Dateien werden direkt übertragen, ohne zusätzliche Dateien, sind aber NUR HTTP gzip komprimiert, wenn der Accept-Encoding Header gesetzt wurde. Mehr Information zu komprimierten API Responses finden Sie hier. Sie können beim Aufruf über den Browser direkt dort betrachtet werden. Die Log-Informationen zu herausgefilterten Produkten werden als <log>-Elemente am Ende angehängt.

Ausgabeformat JSON

JSON ist wie XML ein hierarchisches Format, das jedoch eine etwas platzsparendere Syntax verwendet. Die beiden Formate ähneln sich vom Aufbau her stark.

JSON ist ein hierarchisches Format, in welchem ein übergeordnetes Objekt untergeordnete Objekte einbettet.

Die Feldnamen werden als Namen für die JSON-Elemente verwendet. Referenzierte Objekte wurden bereits aufgelöst und sind direkt im übergeordneten Element eingebunden.

JSON-Dateien werden direkt übertragen, ohne zusätzliche Dateien, sind aber NUR HTTP gzip komprimiert, wenn der Accept-Encoding Header gesetzt wurde. Mehr Information zu komprimierten API Responses finden Sie hier. Sie können beim Aufruf über den Browser direkt dort betrachtet werden. Die Log-Informationen zu herausgefilterten Produkten werden als <log>-Elemente am Ende angehängt