Import von REST-Produktersetzungen (v1)
Diese Quelle wird für den Import von Produktdaten in Quant verwendet. 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 bearbeiten:
- 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 unter Produktersatzattributzuordnung die zu importierenden Attribute aus und ändern Sie optional 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 die automatisierte Aufgabe aktiv ist und Daten über sie gesendet werden können. | ja/nein |
Titel | Benutzerdefinierter Name der automatisierten Aufgabe. | Text |
Beschreibung | Benutzerdefinierte Beschreibung der Funktion für die automatische 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 Strings |
Benutzer mit API-Zugriffsberechtigung | Users with the Robot role who are authorized to run the task. | Liste der Nutzer |
In vorbereiteten Planogrammen ersetzen | Bestimmt, ob auch in vorbereiteten Planogrammen Ersetzungen vorgenommen werden sollen. | ja/nein |
Implementierungszeit in Tagen | Implementierungszeit in Tagen für das ersetzte implementierte Planogramm. | ja/nein |
Implementierungsfoto erforderlich | Gibt an, ob ein Foto der Umsetzung benötigt wird, wenn es eine Änderung im umgesetzten Planogramm gibt. | ja/nein |
Passende Eigenschaft | Eine Produkt-Eigenschaft in Quant, die verwendet wird, um Importartikel mit Produkten in Quant abzugleichen. | Auswahl |
Verzögerung in Sekunden vor dem erneuten Versuch | Empfohlene Verzögerung in Sekunden vor dem erneuten Versuch der Anfrage im Falle eines 503-Fehlers. | ganze Zahl |
Zuordnung von Produktersatzattributen | Eine Zuordnung, die einen Eintrag für jede zu importierende Attribut enthält. | komplexer Typ |
Anfrage
/v1/import/product-replacement/{task_id}
Parameter | Value |
URL | Das Anhängen von ?debug an die URL bewirkt, dass auch Warnungen in der Antwort angezeigt werden. Ohne diesen Parameter werden nur Fehler aufgelistet. |
Kopfzeile | Akzeptieren: application/json |
Kopfzeile | Inhaltstyp: application/json |
Kopfzeile | Autorisierung: Bearer <TOKEN> TOKEN wird mithilfe von /authenticate erhalten (siehe Anmeldung). |
Verfahren | POST |
Der Inhalt der Anfrage ist ein Array von JSON-Objekten, die die in der Einstellung Zuordnung von Produktersatzattributen definierten Schlüssel enthalten.
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 | List of warning strings. Dies ist optional, d. h. es wird nur einbezogen, wenn der Parameter ?debug in der URL enthalten ist und der Import mindestens eine Warnung generiert hat. Liste der Warnmeldungen. |
Fehlern | Optional – nur enthalten, wenn beim Import mindestens ein Fehler aufgetreten ist. Liste der Warnmeldungen. |
Gesamtzeilenanzahl | Optional – wird nur einbezogen, wenn der Import nicht mit dem Status „FEHLER” abgeschlossen wurde. Anzahl der Datensätze bei der Eingabe. |
Fehlende Produkte | Optional – nur enthalten, wenn der Import nicht mit dem Status „FEHLER” abgeschlossen wurde Die Anzahl der Datensätze, die übersprungen wurden, weil das Produkt, auf das sich der Datensatz bezieht, nicht gefunden wurde. |
Duplizierte Produkte | Optional – wird nur einbezogen, wenn der Import nicht mit dem Status „FEHLER” abgeschlossen wurde. Die Anzahl der Datensätze, die übersprungen wurden, da dieses Produkt bereits in derselben Anfrage importiert wurde. |
Anzahl der fehlenden Filialen | Optional – wird nur enthalten, wenn der Import nicht mit dem Status „FEHLER” abgeschlossen wurde. Anzahl der Datensätze, bei denen die referenzierte Filiale nicht gefunden wurde. |
Leere IDs | Optional – wird nur einbezogen, wenn der Import nicht mit dem Status „FEHLER” abgeschlossen wurde. Anzahl der Datensätze, in denen einige IDs leer waren. |
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 Benutzer, 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ähren des Imports ist ein schwerwiegender Serverfehler aufgetreten. |
503 Service Unavailable | 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.
Anfrage
curl -X POST --location "http://[YOUR_COMPANY].iquant.eu/v1/import/product-replacements/54?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d "[{ \"Primary Product ID\": \"100001\", \"Replacement ID\": \"12345\", \"Store ID\": \"Prague 1\" }]"
Antwort
{
"Status": "SUCCESS",
"Total Lines": 1,
"Missing Products": 0,
"Empty IDs": 0,
"Duplicated Products": 0,
"Number of Missing Stores": 0
}