REST-API-Importaktion Produkte
Diese Quelle dient dazu, Aktionsprodukte in Quant zu importieren. Über diesen Importvorgang können Sie in Quant Werbeaktionen anlegen, die sich beispielsweise auf Bestellungen oder die Produktplatzierung in Planogrammen auswirken. Außerdem können Sie mithilfe von Aktionen vorbereitete Regaletiketten drucken. So können Filialen geänderte Regaletiketten ausdrucken, bevor die Aktionsprodukte in den Verkauf gehen. Das Eingabe- und Ausgabeformat ist JSON.
Verwenden Sie den Abschnitt Automatische Aufgaben, um einen Import zu erstellen und zu konfigurieren. Sobald die Aufgabe erstellt wurde, wird ihre ID in der Aufgabenliste angezeigt. Diese ID müssen Sie in die Anfrage-URL einfügen.
- Einstellungen
Bevor Sie die API nutzen können, müssen Sie die folgenden Attribute auf der Registerkarte Einstellungen bearbeiten:
- Aktivieren Sie das Attribut Aktiviert, um die Aufgabe zu aktivieren.
- Wählen Sie unter Benutzer mit API-Zugriffsberechtigung einen oder mehrere Benutzer mit der Rolle Robot aus, die die Berechtigung zum Ausführen der Aufgabe erhalten sollen.
- Wählen Sie unter Zuordnung von Aktions- und Produktattributen die zu importierenden Attribute aus und ändern Sie optional deren JSON-Schlüssel.
- Wir empfehlen außerdem, das Feld E-Mail-Adressen für Benachrichtigungen auszufüllen. Dort können Sie eine oder mehrere E-Mail-Adressen angeben, an die Fehlerbenachrichtigungen 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 |
Beschreigung | Benutzerdefinierte Beschreibung der automatischen Aufgabenfunktion. | formatierter Text |
Notizen | Notizen. | Langtext |
Emails für Benachrichtigungen | Eine oder mehrere E-Mail-Adressen, an die E-Mails mit Fehlermeldungen gesendet werden sollen. | Liste von Zeichenfolgen |
Benutzer mit API-Zugriffsberechtigung | Benutzer mit der Rolle Robot, die zur Ausführung der Aufgabe berechtigt sind. | Benutzerliste |
Verzögerung in Sekunden vor dem erneuten Versuch | Dies ist die Anzahl der Sekunden, die der Client warten soll, bevor er den Import erneut versucht, falls eine lange Warteschlange von Anfragen an den Server vorliegt. | komplexer Typ |
Zuordnung von Aktions- und Produktattributen | Eine Zuordnung, die Felder für Aktionsname, Aktionstyp, Startdatum, Enddatum, Filial-ID und Produkt-ID enthält. | Auswahl |
Maßeinheit | Maßeinheiten wie cm, mm usw. | Auswahl |
Datumsformat | Format für die Datumsangabe, z. B. 31.12.19. | Auswahl |
Datums- und Zeitformat | Format für die Eingabe von Datum und Uhrzeit, z. B. 19.12.31 23:59:59 | Auswahl |
Trennzeichen für Listenelemente | Dies ist das Trennzeichen für Elemente in einer Werteliste. | Auswahl |
Alle Filialen für die leere Geschäftsliste | Aktivieren Sie dieses Kontrollkästchen, wenn die Veranstaltung für alle Filialen gelten soll, sofern keine bestimmte Filiale ausgewählt wurde.. | ja/nein |
Inhalt Produkte und Lager zurücksetzen | Vor dem Import werden alle Produkte aus den enthaltenen Shops entfernt, und nur diejenigen, die im aktuellen Aufgabenlauf enthalten sind, werden der Aktion neu zugewiesen. | ja/nein |
Null-Präfix aus der Store-ID entfernen | Dabei werden alle führenden Nullen aus der Speicher-ID entfernt. So würde beispielsweise die ID 0012 beim Import zu 12 werden. | ja/nein |
- Anfrage
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 aus JSON-Objekten, das die Schlüssel enthält, die in der Einstellung Zuordnung von Aktions- und Produktattributen definiert sind.
Es ist wichtig, dass die Anfrage den JSON-Standards entspricht. Diese sind beispielsweise hier definiert. Bitte senden Sie numerische Attributwerte ohne Anführungszeichen, siehe Beispiel.
- Antwort
Schlüssel | Wert |
Status | Eine Zeichenfolge, die den endgültigen Zustand des Imports beschreibt.
|
Warnungen | Es ist optional, d.h. es ist nur enthalten, wenn der Parameter ?debug in der URL enthalten ist und der Import mindestens eine Warnung erzeugt hat. Liste der Warnzeichenfolgen. |
Fehler | Optional - nur enthalten, wenn der Import mindestens einen Fehler erzeugt hat. Liste der Fehlerzeichenfolgen. |
- Status Codes
Status | Wert |
200 OK | Import erfolgreich mit dem Status "SUCCESS" oder "PARTIAL_SUCCESS". Die Antwort kann Warnungen oder kleinere Fehler enthalten. |
400 Bad Request | Fehlerhafte Aufgabeneinstellungen oder falsche Anfrage. |
401 Nicht autorisiert | Das Autorisierungs-Token ist ungültig, oder der Benutzer, der mit dem Token angemeldet ist, hat keine Berechtigung zur Ausführung dieser Aufgabe. |
404 Nicht gefunden | Es wurde keine Aufgabe mit der in der URL angegebenen ID gefunden. |
500 Internal Server Error | Beim Export ist ein kritischer serverseitiger Fehler aufgetreten. |
503 Dienst nicht verfügbar | Die Aufgabe wird bereits ausgeführt. Versuchen Sie, die Aufgabe nach der in der Antwortkopfzeile Retry-After angegebenen Anzahl von Sekunden erneut zu starten. |
- Neueste Protokolle
In Quant können Sie neben den Aufgabeneinstellungen auch die Protokolle einzelner Importe einsehen, einschließlich Statistiken, Fehlern und Warnungen.
Wir können die Details eines bestimmten Datensatzes anzeigen, indem wir ihn auswählen und auf die Schaltfläche Dateien herunterladen klicken.
- Anfrage
curl -X POST --location "https://[YOUR_COMPANY].iquant.eu/v1/import/action-products/311028?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d "[{"Start Date":"1.11.24","End Date":"31.12.24","Primary Product ID":"100006","Name":"Promo 2 2024","Stores":"12,12564", "Action Type":"Flyer","Action valid until (Store Specific)":"1.11.24","Basic Sales Price":15.5,"Basic Sales Price (Default)":20},
{"Start Date":"1.11.24","End Date":"31.12.24","Primary Product ID":"100030","Name":"Promo 2 2024","Stores":"12,12564", "Action Type":"Flyer"}
]"
- Antwort
{
"Status": "SUCCESS",
}