REST API Import von Bestellungen
Diese Quelle wird für den Import von Bestellungsdaten in Quant verwendet. Das Eingabe- und Ausgabeformat ist JSON.
Verwenden Sie den Bereich "Automatische Aufgaben", um einen Import 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/import/order-data/{task_id}
Parameter | Wert |
URL | ?debug zur URL hinzugefügt wird, wird in der Antwort auch eine Warnung angezeigt. Ohne sie werden nur Fehler aufgeführt. |
Kopfzeile | Accept: application/json |
Kopfzeile | Content-type: application/json |
Kopfzeile | Authorization: Bearer <TOKEN> TOKEN erhält man über /authenticate (siehe Login). |
Methode | POST |
Der Inhalt der Anfrage ist ein Array von JSON-Objekten, das die in der Einstellung für die Zuordnung von Bestelldatenattributen definierten Schlüssel enthält, insbesondere die Bestell-QID, die primäre Produkt-ID und das genehmigte Volumen.
Antwort
Schlüssel | Wert |
Status | Eine String, der den endgültigen Status des Imports beschreibt.
|
Warnungen | Optional - nur enthalten, wenn der Parameter ?debug in der URL enthalten ist und der Import mindestens eine Warnung erzeugt hat. Liste der Warnstrings. |
Fehler | Optional - nur enthalten, wenn der Import mindestens einen Fehler verursacht hat. Liste der Fehlerstrings. |
Auf der Grundlage der Anfrage setzt Quant das genehmigte Volumen für alle im Rahmen der Bestellung versendeten Produkte fest. Für Produkte, die Teil der Bestellung waren, für die wir aber keine Informationen über das genehmigte Volumen erhalten haben, setzt Quant das genehmigte Volumen auf 0. Gleichzeitig ändert es den Status der Bestellung auf Bestellt. Auch nach der Änderung des Bestellungsstatus ist es möglich, eine genehmigte Menge eines anderen Produkts über die REST API Orders Import zur Bestellung hinzuzufügen.
Status Codes
Status | Wert |
200 OK | Import 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 Imports ist ein kritischer serverseitiger Fehler aufgetreten. |
503 Service Unavailable | Die Aufgabe läuft bereits. Der Start der Aufgabe wird nach der im Antwortkopf Retry-After angegebenen Anzahl von Sekunden wiederholt. |
Ausführungs-Log
In Quant können Sie zusätzlich zu den Aufgabeneinstellungen auch Aufzeichnungen über einzelne Importe einsehen, einschließlich Statistiken, Fehler und Warnungen.
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 "https://[YOUR_COMPANY].iquant.eu/v1/import/order-data/54?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d '[{"QID":"932554","Primary Product Id":"100034","Approved Volume":150}]'
Antwort
{
"Status": "SUCCESS",
}