REST-API-Bestellungseigenschaften importieren
Über diese Quelle werden Bestellungseigenschaften in Quant importiert, hauptsächlich um den Status von Bestellungen zu ändern. Das Eingabe- und Ausgabeformat ist JSON.
Verwenden Sie den Abschnitt Automatische Aufgaben, um einen Import 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 anpassen:
- Aktivieren Sie die Eigenschaft Aktiviert, um die Aufgabe zu aktivieren.
- Wählen Sie unter Nutzer mit API-Zugriffsberechtigung einen oder mehrere Nutzer mit der Rolle Roboter aus, die die Berechtigung zum Ausführen der Aufgabe erhalten sollen.
- Wählen Sie in der Attribut-Mapping für Bestelleigenschaften die zu importierenden 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 | Beschreibung | Typ |
Aktiviert | Gibt an, ob der Nutzer auf diese Quelle zugreifen darf. | ja/nein |
Titel | Benutzerdefinierter Name der automatisierten Aufgabe. | Text |
Beschreibung | Custom description of the automatic task function. | formatierter Text |
Bemerkungen | Notiz. | länger Text |
E-Mails für Benachrichtigungen | Eine oder mehrere E-Mail-Adressen, an die E-Mails mit Fehlermeldungen gesendet werden. | Liste von Strings |
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 Import 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 die Produkt-ID, die QID und das genehmigte Volumen enthält. | komplexer Type |
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 |
Listenelement-Trennzeichen | Zeichen zum Trennen der Elemente der Werteliste. | Zeichen |
- Anfrage
/v1/import/order-properties/{task_id}
Parameter | Value |
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 | Content-Typ: application/json |
Kopfzeile | Autorisierung: Bearer <TOKEN> Das TOKEN wird über /authenticate erhalten (siehe Anmeldung). |
Verfahren | POST |
Der Inhalt der Anfrage ist ein Array von JSON-Objekten, die die in der Einstellung „Order Properties Attribute Mapping“ (Zuordnung von Bestellungseigenschaften) definierten Schlüssel enthalten, insbesondere die Bestellung-QID und deren Status. Die Statusnamen sollten Geliefert, Bestellt, Storniertund Offen lauten. Wenn Sie Statusnamen in einem anderen Format senden möchten, müssen Sie dies in der Eigenschaftenzuordnung in der Zeile Textersetzung einrichten.
Es ist wichtig, dass die Anfrage den JSON-Standards entspricht. Diese sind beispielsweise hier definiert. Bitte senden Sie numerische Eigenschaftwerte ohne Anführungszeichen, siehe Beispiel.
Antwort
Schlüssel | Wert |
Status | Eine Zeichenfolge, die den endgültigen Status des Imports beschreibt.
|
Warnungen | Optional – nur enthalten, wenn der Parameter debug in der URL vorhanden ist und der Import mindestens eine Warnung generiert hat. Liste der Warnmeldungen. |
Fehler | Optional – nur enthalten, wenn beim Import mindestens ein Fehler aufgetreten ist. Liste der Fehlermeldungen. |
Statuscodes
Status | Wert |
200 OK | Import 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 Nutzer, der mit dem Token angemeldet ist, verfügt nicht über die Berechtigung, diese Aufgabe durchzuführen. |
404 Not Found | Es wurde keine Aufgabe mit der in der URL angegebenen ID gefunden. |
500 Internal Server Error | Während des Imports ist ein schwerwiegender Fehler auf der Serverseite aufgetreten. |
503 Service Unavailable | Die Aufgabe wird bereits ausgeführt. Bitte versuchen Sie, die Aufgabe nach Ablauf der im Antwort-Header „Retry-After“ angegebenen Sekunden erneut zu starten. |
Ausführungslog
In Quant können Sie neben den Aufgabeneinstellungen auch Aufzeichnungen einzelner Importe 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 "https://[YOUR_COMPANY].iquant.eu/v1/import/order-properties/54?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d "[{\"QID\":\"932554\",\"State\":\"Delivered\"},
{\"QID\":\"1289017\",\"State\":\"Canceled\"}
]"
Antwort
{
"Status": "SUCCESS",
}