REST-API-Attribute der Bestellung exportieren
Diese Quelle wird verwendet, um Eigenschaften von Bestellungen aus Quant zu exportieren. Diese automatisierte Aufgabe exportiert alle Eigenschaften der Bestellungen, insbesondere die Auftrags-QID und den Auftragsstatus. Das Eingabe- und Ausgabeformat ist JSON.
Verwenden Sie den Abschnitt Automatische Aufgaben, um einen Export zu erstellen und einzurichten. Nach der Erstellung erhält die Aufgabenliste die ID, die Sie in der Anfrage-URL übergeben.
Einstellungen
Bevor Sie die API verwenden können, müssen Sie die folgenden Eigenschaften auf der Registerkarte Einstellungen bearbeiten:
- Aktivieren Sie die Eigenschaft Aktiviert, um die Aufgabe zu aktivieren.
- In the Users with API Access Permission, select one or more users with the Robot role who will have permission to run the task.
- Wählen Sie in der Attribute-Mapping für Bestelleingenschaften die zu exportierenden Eigenschaften aus und ändern Sie gegebenenfalls deren JSON-Schlüssel.
- Weiterhin empfehlen wir Ihnen, das Feld E-Mail-Adressen für Benachrichtigungen auszufüllen, in dem Sie eine oder mehrere E-Mail-Adressen angeben, an die E-Mails mit Fehlermeldungen gesendet werden sollen.
Attribute
Attribute | Bechreibung | Typ |
Aktiviert | Gibt an, ob der Benutzter Zugriff auf diese Quelle hat. | ja/nein |
Titel | Benutzerdefinierter Name der automatisierten Aufgabe. | Text |
Beschreibung | Benutzerdefinierte Beschreibung der automatischen Aufgabe. | formatierter Text |
Bemerkungen | Notizen. | langer Text |
E-Mails für Benachrichtigungen | Eine oder mehrere E-Mail-Adressen, an die E-Mails mit Fehlermeldungen gesendet werden. | Liste von Zeichenfolgen |
Benutzer mit API-Zugriffsberechtigung | Benutzer mit der Rolle Roboter, die zur Ausführung der Aufgabe berechtigt sind. | Liste der Nutzer |
Verzögerung in Sekunden vor dem erneuten Versuch | Die Anzahl der Sekunden, die der Client warten sollte, bevor er den Export erneut versucht, falls eine lange Warteschlange von Anfragen an den Server vorliegt. | ganze Zahl |
Attribute-Mapping für Bestelleingenschaften | Eine Zuordnung, die einen Eintrag für jede zu exportierende Eigenschaft enthält. | komplexer Typ |
Maßeinheit | Maßeinheit wie z. B. cm, mm usw. | Auswahl |
Datumsformat | Datumsformat, z. B. 31.12.19 | Auswahl |
Datums- und Zeitformat | Datum- und Zeitformat, z. B. 31.12.19 23:59:59 | Auswahl |
Trennzeichen für Listenelemente | Zeichen zum Trennen der Elemente der Werteliste. | Charakter |
- Anfrage
/v1/export/order-properties/{task_id}
Parameter | Wert |
URL | Wenn ?debug zur URL hinzugefügt wird, wird in der Antwort ebenfalls eine Warnung angezeigt. Ohne diesen Zusatz werden nur Fehler aufgelistet. |
Kopfzeile | Akzeptieren: application/json |
Kopfzeile | Inhaltstyp: application/json |
Kopfzeile | Autorisierung: Bearer <TOKEN> TOKEN wird enthalten über /authenticate (siehe Login). |
Verfahren | POST |
Der Inhalt der Anfrage ist ein JSON-Objekt, das den folgenden Schlüssel enthält:
Schlüssel | Wert |
Datum | In der Anfrage müssen Sie angeben, für welchen Tag die Bestellungen exportiert werden sollen. Beispiele: {"date":"12.9.24"} |
Antwort
Schlüssel | Wert |
Status | Eine Zeichenfolge, die den endgültigen Status des Exports beschreibt.
|
Warnungen | Optional – nur enthalten, wenn der Parameter „debug“ in der URL vorhanden ist und der Export mindestens eine Warnung generiert hat. Liste der Warnmeldungen. |
Fehler | Optional – nur enthalten, wenn beim Export mindestens ein Fehler aufgetreten ist. Liste der Fehlermeldungen. |
Aufzeichnung | Optional – wird nur einbezogen, wenn der Export nicht mit dem Status FEHLER abgeschlossen wurde. Liste der exportierten Objekte. Jedes Objekt enthält die Schlüssel, die durch die Zuordnung 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 | Fehlerhafte Aufgabeneinstellungen oder fehlerhafte Anfrage. |
401 Unauthorized | Das Autorisierungstoken ist ungültig oder der Benutzer, der mit dem Token angemeldet ist, verfügt nicht über die Berechtigung, diese Aufgabe auszuführen. |
404 Not Found | Es wurde keine Aufgabe mit der in der URL angegebenen ID gefunden. |
500 Internal Server Error | Währen des Exports ist ein schwerwiegender Fehler auf der Serverseite aufgetreten. |
Ausführungslog
In Quant können Sie neben den Aufgabeneinstellungen auch Aufzeichnungen einzelner Exporte einsehen, einschließlich Statistiken, Fehlern und Warnungen.
Wenn wir einen bestimmten Datensatz auswählen, können wir dessen Details anzeigen, indem wir auf die Schaltfläche Artikel anzeigen klicken.
Anfrage
curl -X POST --location "http://[YOUR_COMPANY].iquant.eu/v1/export/order-properties/246?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
--data "{\"Date\":\"12.9.24\"}
Antwort
{
"Status": "SUCCESS", "Records": [
{"QID": "933291", "Store ID": "198 - Prague", "State": "Ordered", "Order Date": "10.10.23", "Delivery Date": "11.10.23"},
{"QID": "933292", "Store ID": "450 - Kolín", "State": "Delivered", "Order Date": "10.10.23", "Delivery Date": "11.10.23"},
]
}