TB.One > Auftragsdaten und Auftragsabwicklung > Auftragsbearbeitung via XML > Auftragsbearbeitung via XML mit REST

Auftragsbearbeitung via XML mit REST

ACHTUNG:
Wenn Daten über REST abgeholt werden, musst du sie als "exportiert" kennzeichnen, wenn du sie erfolgreich abgeholt hast.

Beachte, dass eine Authentifizierung mit Nutzername und Passwort nötig ist, um die REST-Schnittstelle zu nutzen. Erstelle dazu unter "Admin > Benutzer > Mitarbeiter" einen API-Nutzer.

 

Die REST-Schnittstelle wird über eine URI aufgerufen, die den Nutzer identifiziert und die gewünschte Aktion angibt:

https://rest.core.tradebyte.com/HNR/ZIEL/[ZIEL_ID][/ACTION]?[CHANNEL=CHID]

 

ACHTUNG:
Es macht Sinn, neue Aufträge nicht häufiger als alle 60 Minuten abzuholen. Manche Kanäle stellen sogar nur zweimal täglich neue Aufträge bereit.

1. PFLICHTFELDER

ABKÜRZUNG

BESCHREIBUNG

HNR

Nummer des TB.One-Accounts/Händlernummer

ZIEL

Gibt an, auf welche Ressourcengruppe der Rest-Call abzielt, also Aufträge (orders), Rechnungen (invoices) oder Meldungen (messages).

2. ZUSÄTZLICHE INFORMATIONEN

ABKÜRZUNG

BESCHREIBUNG

ZIEL_ID

ID der Ressource, die abgerufen oder verändert werden soll, also z.B. eine bestimmte Auftrags-ID.

ACTION

Befehl zur Änderung der über die ZIEL_ID angesprochenen Ressource.
"exported" markiert, dass ein Datensatz abgerufen wurde; "deliverynote", "invoice", "shiplabel","returnlabel", falls die entsprechenden Dokumente abgerufen werden sollen.

CHANNEL

Wenn du den Abruf auf einen bestimmten Kanal einschränken möchtest (z.B. um Aufträge für einen bestimmten Kanal abzurufen), ergänze den Aufruf CHANNEL mit der Kanal-ID (nicht Kanalkürzel).

 

3. REST CALLS

Die einzelnen REST-Aufrufe werden auf folgenden Seiten beschrieben:

•Auftragsdateien (Orders) und Dokumente abrufen

•Statusänderungen nach erfolgreichem Abruf

•Senden und Abholen von Meldungen (Messages)

 

4. STATUSCODES

Beachte neben den Inhalten auch stets den zurückgespielten http-Statuscode (Header):

•200 (alle Codes die mit 2xx beginnen): Abruf/Verarbeitung erfolgreich

•400 (alle Codes die mit 4xx beginnen): Abruf/Anfrage nicht erfolgreich

•500 (alle Codes die mit 5xx beginnen): Verarbeitungsfehler

 

Beispiel (erfolgreiche Verarbeitung):

Header-Rückmeldung:

Status Code: 200 OK

 

Die Statuscodes beziehen sich ausschließlich auf die Verbindung der Systeme über REST. Sie sagen nichts über die Richtigkeit der ausgetauschten Inhalte aus. Deshalb kann beispielsweise ein Header die Rückmeldung "200 OK" beinhalten, obwohl keine Änderungen vorgenommen wurden.

Weiterführende Informationen:

•Auftragsbearbeitung via XML - Übersicht

•Auftragsbearbeitung via XML - Dateien und Namenskonventionen

•Feldbeschreibungen - Auftragsdateien

•Feldbeschreibungen - Meldungsdateien