TB.One > Auftragsdaten und Auftragsabwicklung > Auftragsbearbeitung via XML > Auftragsdateien (Orders) und Dokumente über REST-Call abholen
Die REST-Schnittstelle wird über eine URI aufgerufen, die den Nutzer identifiziert und die gewünschte Aktion angibt:
https://rest.core.tradebyte.com/HNR/TARGET/[TARGET_ID][/ACTION]?[CHANNEL=CHID] |
|---|
Der Export von schwebenden Aufträgen kann unter "Admin > Export > Aufträge" aktiviert werden. Falls nötig, können in den Einstellungen des entsprechenden Kanals weitere Einstellungen vorgenommen werden ("Kanäle > [Dein Kanal] > Einstellungen").
Methode |
GET |
Holt im Format XML (bzw. openTRANS) ... |
|---|---|---|
Ziel/Ressource |
orders |
... Aufträge ab, die noch nicht abgeschlossen wurden (inklusive schwebender Aufträge, falls die entsprechende Funktion aktiviert wurde) ... |
CHANNEL |
?channel=CHID |
... und die über den genannten Kanal eingegangen sind. |
Parameter |
&mode=tborder |
Der Parameter "mode" setzt das Format der Order-Datei auf Tradebyte's "TB.Order" Format. Falls TB.Order nicht möglich ist, kann openTRANS genutzt werden (&mode=opentrans). |
Beispiel |
https://rest.core.tradebyte.com/HNR/orders/?channel=CHID |
|
Rückmeldung |
<?xml version="1.0" encoding="UTF-8"?> <ORDER_LIST> <ORDER>...</ORDER> <ORDER>...</ORDER> </ORDER_LIST> |
|
Methode |
GET |
Holt im PDF-Format ... |
|---|---|---|
Ziel/Ressource |
orders |
... die Dokumente ... |
ZIEL_ID |
ORDER_ID |
... der angegebenen Order ID. |
Parameter |
deliverynote |
Hier: Lieferschein |
Beispiel |
https://rest.core.tradebyte.com/HNR/orders/ORDER_ID/deliverynote? |
|
Rückmeldung |
200 OK Bzw. PDF-Datei |
|
Mögliche Fehler |
"TCPDF ERROR: [Image] No such file or directory in TCPDF ERROR: Some data has already been output to browser, can't send PDF file" In diesem Fall wurde unter "Admin > Systemeinstellungen > Dokumente" kein Firmenlogo hochgeladen. |
|
Methode |
GET |
Holt im PDF-Format ... |
|---|---|---|
Ziel/Ressource |
orders |
... die Dokumente ... |
ZIEL_ID |
ORDER_ID |
... der angegebenen Order ID. |
Parameter |
invoice |
Hier: die neueste Rechnung |
Beispiel |
https://rest.core.tradebyte.com/HNR/orders/ORDER_ID/invoice? |
|
Rückmeldung |
200 OK Bzw. PDF-Datei |
|
Mögliche Fehler |
"TCPDF ERROR: [Image] No such file or directory in TCPDF ERROR: Some data has already been output to browser, can't send PDF file" In diesem Fall wurde unter "Admin > Systemeinstellungen > Dokumente" kein Firmenlogo hochgeladen. |
|
Methode |
GET |
Holt im PDF-Format ... |
|---|---|---|
Ziel/Ressource |
orders |
... die Dokumente ... |
ZIEL_ID |
ORDER_ID |
... der angegebenen Order ID. |
Parameter |
shiplabel |
Hier: das Versandlabel |
Beispiel |
https://rest.core.tradebyte.com/HNR/orders/ORDER_ID/shiplabel? |
|
Rückmeldung |
200 OK Bzw. PDF-Datei |
|
Mögliche Fehler |
"TCPDF ERROR: [Image] No such file or directory in TCPDF ERROR: Some data has already been output to browser, can't send PDF file" In diesem Fall wurde unter "Admin > Systemeinstellungen > Dokumente" kein Firmenlogo hochgeladen. |
|
Methode |
GET |
Holt im PDF-Format ... |
|---|---|---|
Ziel/Ressource |
orders |
... die Dokumente ... |
ZIEL_ID |
ORDER_ID |
... der angegebenen Order ID. |
Parameter |
returnlabel |
Hier: das Retourenlabel |
Beispiel |
https://rest.core.tradebyte.com/HNR/orders/ORDER_ID/returnlabel? |
|
Rückmeldung |
200 OK Bzw. PDF file |
|
Mögliche Fehler |
"TCPDF ERROR: [Image] No such file or directory in TCPDF ERROR: Some data has already been output to browser, can't send PDF file" In diesem Fall wurde unter "Admin > Systemeinstellungen > Dokumente" kein Firmenlogo hochgeladen. |
|
Weiterführende Informationen:
•Auftragsbearbeitung via REST - Übersicht und Statuscodes
•Auftragsbearbeitung via XML - Dateien und Namenskonventionen