REST API Export platzierter Produkte V1
Diese Quelle wird verwendet, um Produkte zu exportieren, die in Planogrammen in Quant platziert sind. Eingabe- und Ausgabeformat ist JSON.
Benutzen Sie den Abschnitt Automatische Aufgaben, um einen Export zu erstellen und einzurichten. Nach der Erstellung hat die Aufgabenliste die ID, die Sie in der Anfrage-URL übergeben.
Einstellungen
Bevor Sie die API verwenden, müssen Sie die folgenden Attribute auf der Registerkarte Einstellungen bearbeiten:
- Kreuzen Sie das Attribut Aktiviert an, 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 sind.
- Wählen Sie unter Placed Product Attribute Mapping die zu exportierenden Attribute aus und ändern Sie optional deren JSON-Schlüssel
Attribute
Attribut | Beschreibung | Typ |
Entspricht | Gibt an, ob die automatische Aufgabe aktiv ist und ob die Daten durch sie gesendet werden können. | ja/nein |
Titel | Eigene Name der automatischen Aufgabe. | Text |
Beschreibung | Benutzerdefinierte Beschreibung der Funktion der automatischen Aufgabe. | Formatierter Text |
Hinweise | Notizen. | Langtext |
E-Mails für Benachrichtigungen | Eine oder mehrere E-Mail-Adressen, an die E-Mails mit Fehlerbedingungen gesendet werden sollen. | Liste von Strings |
Benutzer mit API-Zugangsberechtigung | Benutzer mit der Rolle Roboter, die berechtigt sind, die Aufgabe auszuführen. | Liste der Benutzer |
Maßeinheit | Maßeinheit wie cm, mm usw. | Auswahl |
Datumsformat | Datumseingabeformat, z.B. 31.12.19 | Auswahl |
Datum und Zeitformat | Datumseingabeformat und Uhrzeit, z. B. 31.12.19 23:59:59 | Auswahl |
Plaziertes Produktattribut-Mapping | Ein Mapping mit einem Eintrag für jedes Attribut des platzierten Produkts, das exportiert werden soll. | komplexer Typ |
Läden | Ein Filter, der bestimmt, welche Zweige in den Export einbezogen werden. | komplexer Typ |
Kumulierungsgrad | Auswahl der Kumulierung nach Ebene Block / Regal / Halterung / Lager / Status. | Auswahl |
Plazierte Produkte | Produkte, die in Planogrammen platziert sind, werden in den Export einbezogen. | ja/nein |
Nicht platzierte Produkte | Der Export umfasst Produkte, die in der Planogrammvorlage platziert, aber nicht im Planogramm enthalten sind (in der Vorlage durchgestrichen). | yes/no |
Nicht platzierte Backstock-Produkte | Der Export umfasst auch nicht platzierte Produkte, die im Block als im Zwischenlager befindlich festgelegt sind. | ja/nein |
Space Type | Wählen Sie aus, ob Sie räumliche Daten wie m, m2 oder m3 sehen möchten. | Auswahl |
Niveau der normalisierten Kategorie | Die Ebene der Kategorien innerhalb der Hierarchie, die im Export angezeigt werden soll. | Nummer |
Anfrage
/v1/export/placed-products/{task_id}
Parameter | Wert |
URL | ?debug, das der URL hinzugefügt wird, zeigt auch eine Warnung in der Antwort an. Ohne diese Option werden nur Fehler angezeigt. |
Kopfzeile | Accept: application/json |
Kopfzeile | Inhaltstyp: application/json |
Kopfzeile ( | Accept-Encoding: gzip, deflate, br |
Kopfzeile | Berechtigung: Bearer <TOKEN> TOKEN se získává pomocí /authenticate (siehe Login). |
Methode | POST |
Der Inhalt der Anfrage ist ein JSON-Objekt, das die folgenden Schlüssel enthält:
Schlüssel | Wert |
PlanogramStates | Eine separate Zeichenkette oder ein Array von Zeichenketten, die angeben, welche Planogrammzustände durch den Export verarbeitet werden sollen. Mögliche Werte: VORBEREITET / WARTEND / IMPLEMENTIERT Beispiele: { "PlanogramStates": "VORBEREITET" } { "PlanogramStates": [ "VORBEREITET", "WARTEND" ] } |
StoreIds | Ein optionales Array von Strings, die die vom Export zu verarbeitenden Filialen angeben. Die Filial-ID muss immer als String angegeben werden, auch wenn es sich nur um eine Filiale handelt. Wenn nur ein leerer Wert angegeben wird, werden alle Niederlassungen exportiert, die in den automatischen Aufgabeneinstellungen angegeben sind. Wenn z. B. eine Filiale mit der Kennung "12" nicht in den automatischen Aufgabeneinstellungen enthalten ist und eine Anfrage für diese Filiale gesendet wird, wird nur der leere Wert exportiert. Beispiele: { "StoreIds": [ "12" ] } { "StoreIds": [ "12", "135","209" ] } |
Antwort
Schlüssel | Wert |
Status | Eine Zeichenfolge, die den endgültigen Zustand des Exports beschreibt.
|
Warnungen | Sie ist optional, d.h. sie wird nur eingefügt, wenn der Parameter ?debug in der URL enthalten ist und der Export mindestens eine Warnung erzeugt hat. Liste der Warnzeichenfolgen. |
Fehler | Optional - nur enthalten, wenn der Export mindestens einen Fehler erzeugt hat. Liste der Fehlerzeichenfolgen. |
Rekorde | Optional - wird nur eingefügt, wenn der Export nicht mit dem Status "FAILURE" beendet wurde. Liste der exportierten Objekte. Jedes Objekt enthält Schlüssel, die durch die Zuordnung in den Auftragseinstellungen definiert sind. |
Status Codes
Status | Wert |
200 OK | Export 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. |
Ausführungsprotokoll
In Quant können Sie neben den Aufgabeneinstellungen auch Aufzeichnungen zu einzelnen Exporten einsehen, darunter Statistiken, Fehler und Warnungen.
Wenn wir einen bestimmten Datensatz auswählen, können wir seine Details anzeigen, indem wir auf die Schaltfläche Elemente anzeigen klicken.
Anfrage
curl -X POST --location "http://localhost:4150/v1/export/placed-products/10?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d '{ "PlanogramStates": ["VORBEREITET", "WARTET"] , "StoreIds": [ "12" ]}'
Antwort
{
"Status": "SUCCESS", "Records": [
{"Planogramm-ID": "166882", "Primärprodukt-ID": "100001", "Vorrichtungs-ID": "1231"},
{"Planogramm ID": "166850", "Primäre Produkt ID": "100005", "Vorrichtungs ID": "1232"},
... ]
}