REST API Export von Bestellungen
Diese Quelle wird für den Export von Bestellungsdaten nach Quant verwendet. Das Eingabe- und Ausgabeformat ist JSON.
Verwenden Sie den Bereich "Automatische Aufgaben", um einen Export zu erstellen und einzurichten. Nach der Erstellung erhält die Aufgabenliste die ID, die Sie in der Anfrage-URL angeben.
Einstellungen
Bevor Sie die API verwenden, müssen Sie die folgenden Attribute auf der Registerkarte Einstellungen bearbeiten:
- Markieren Sie das Attribut Aktiviert, um die Aufgabe zu aktivieren.
- Wählen Sie im Feld Benutzer mit API-Zugriffsberechtigung einen oder mehrere Benutzer mit der Rolle Roboter aus, die zur Ausführung der Aufgabe berechtigt sein sollen.
- Wählen Sie in der Bestellungsdaten-Attribut-Zuordnung die zu exportierenden Attribute aus und ändern Sie optional deren JSON-Schlüssel.
Attribute
Attribut | Beschreibung | Typ |
Aktiviert | Gibt an, ob der Benutzer auf diese Ressource zugreifen kann. | Ja/Nein |
Titel | Benutzerdefinierter Name für die automatisierte Aufgabe. | Text |
Beschreibung | Benutzerdefinierte Beschreibung der automatischen Aufgabenfunktion. | formatierter Text |
Bemerkungen | Bemerkungen. | Langtext |
Emails für Benachrichtigungen | Eine oder mehrere E-Mail-Adressen, an die E-Mails mit Fehlerbedingungen gesendet werden sollen. | Liste von Strings |
Benutzer mit API-Zugriffsberechtigung | Benutzer mit der Rolle Roboter, die berechtigt sind, die Aufgabe auszuführen. | Liste der Benutzer |
Verzögerung in Sekunden vor erneutem Versuch | Die Anzahl der Sekunden, die der Kunde warten soll, bevor er den Export erneut versucht, falls eine lange Wartezeit für Anfragen an den Server besteht. | ganze Zahl |
Bestellungsdaten-Attribut-Zuordnung | Eine Zuordnung, die einen Eintrag für jedes zu exportierende Attribut enthält. | komplexer Typ |
Maßnahme Einheit | Maßeinheit wie cm, mm, usw. | Auswahl |
Datum Format | Format der Datumseingabe, z.B. 31.12.19 | Auswahl |
Format von Datum und Uhrzeit | Datum und Zeitformat, z.B. 31.12.19 23:59. | Auswahl |
Listenelement-Trennzeichen | Zeichen für die Aufteilung der Elemente der Werteliste. | Zeichen |
- Anfrage
/v1/export/order-data/{task_id}
Parameter | Wert |
URL | ?debug zur URL hinzugefügt wird, wird in der Antwort auch eine Warnung angezeigt. Ohne diesen Zusatz werden nur Fehler angezeigt. |
Kopfzeile | Accept: application/json |
Kopfzeile | Content-type: application/json |
Kopfzeile | Authorization: Bearer <TOKEN> TOKEN erhält man über /authenticate (siehe Login). |
Methode | POST |
Antwort
Schlüssel | Wert |
Status | Ein String, der den endgültigen Status des Exports beschreibt.
|
Warnungen | Optional - nur enthalten, wenn der Parameter ?debug in der URL enthalten ist und der Export mindestens eine Warnung erzeugt hat. Liste der Warnstrings. |
Fehler | Optional - nur enthalten, wenn der Export mindestens einen Fehler verursacht hat. Liste der Fehlerstrings. |
Datensatz | Optional - ist nur enthalten, wenn der Export nicht mit dem Status "FAILURE" abgeschlossen wurde. Liste der exportierten Objekte. Jedes Objekt enthält die Schlüssel, die durch das Zuordnen in den Aufgabeneinstellungen definiert sind. |
Status Codes
Status | Wert |
200 OK | Export erfolgreich mit Status "SUCCESS" oder "PARTIAL_SUCCESS". Die Antwort kann Warnungen oder kleinere Fehler enthalten. |
400 Bad Request | Falsche Aufgabeneinstellungen oder falsche Anfrage. |
401 Unauthorized | Das Berechtigungs-Token ist ungültig, oder der mit dem Token angemeldete Benutzer hat keine Berechtigung zur Ausführung dieser Aufgabe. |
404 Not Found | Es wurde keine Aufgabe mit der in der URL angegebenen ID gefunden. |
500 Internal Server Error | Während des Exports ist ein kritischer serverseitiger Fehler aufgetreten. |
Ausführungs-Log
In Quant können Sie zusätzlich zu den Aufgabeneinstellungen auch Datensätze zu einzelnen Exporten, einschließlich Statistiken, Fehlern und Warnungen, anzeigen.
Wenn wir einen bestimmten Datensatz auswählen, können wir seine Details anzeigen, indem wir auf die Schaltfläche Artikel anzeigen klicken.
Anfrage
curl -X POST --location "http://[YOUR_COMPANY].iquant.eu/v1/export/order-data/246?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d '{}'
Antwort
{
"Status": "SUCCESS", "Records": [
{"QID": "933291", "Store ID": "198", "Primary Product Id": "100005", "Order Date": "10.10.23", "Delivery Date": "11.10.23", "Suggested Volume": "30"},
{"QID": "933291", "Store ID": "198", "Primary Product Id": "100018", "Order Date": "10.10.23", "Delivery Date": "11.10.23", "Suggested Volume": "50"},
... ]
}