REST API Export von filailspezifischen Produktdaten V1
Verwenden Sie diese Ressource, um Quant-Produktdaten zu exportieren, die für jede Filiale spezifisch sind. Sie verwendet derzeit JSON als Input und Output.
Verwenden Sie den Abschnitt "Automatische Aufgaben", um einen Export zu erstellen und einzurichten. Nach der Erstellung erhält die Aufgabenliste die ID, die Sie in der Anforderungs-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 Roboterrolle aus, die die Aufgabe ausführen dürfen.
- Wählen Sie im REST Exportable Product Store Attribute Mapping die zu exportierenden Attribute aus und ändern Sie optional deren JSON-Schlüssel
Attribute
Attribut | Beschreibung | Typ |
Aktiviert | Gibt an, ob die automatische Aufgabe aktiv ist und Daten über sie gesendet werden können. | 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örgerung in Sekunden vor dem erneuten Versuch | Die Anzahl der Sekunden, die der Client warten soll, bevor er den Export erneut versucht, falls eine lange Warteschlange von Anfragen an den Server besteht. | ganze Zahl |
REST-exportierbare filialspezifische-Produktattributzuordnung | Ein Mapping, das für jedes zu exportierende Attribut einen Eintrag enthält. | komplexe Form |
Maßeinheit | Maßeinheit wie cm, mm usw. | Auswahl |
Datumsformat | Format der Datumseingabe, z.B. 31.12.19 | Auswahl |
Datums- und Uhrzeitformat | Eingabeformat für Datum und Uhrzeit, z. B. 19.12.31 23:59:59 | Auswahl |
Listenelement-Trennzeichen | Zeichen für die Aufteilung der Elemente der Werteliste. | Zeichen |
Produkt-Set | Verwenden Sie das Produktset, um die zu exportierenden Produkte auszuwählen. | Auswahl |
Filialen | Sie können auswählen, welche Filialen exportiert werden sollen. | Auswahl |
Anfrage
/v1/export/store-specific-product-data/{task_id}
Parameter | Wert |
URL | ?debug added to the URL will also display warnings in the response. Without it, only errors are listed. |
Kofpfzeile | Accept: application/json |
Kopfzeile | Content-type: application/json |
Kofpzeile | Authorization: Bearer <TOKEN> TOKEN erhält man durch /authenticate (see Login). |
Methode | POST |
Der Inhalt der Anfrage ist ein JSON-Objekt, das die folgenden Schlüssel enthält:
Schlüssel | Wert |
StoreIds | In der Anfrage müssen Sie angeben, für welche Filiale die Produktdaten exportiert werden sollen. Es ist immer möglich, nur eine Filiale auszuwählen. Wenn zum Beispiel eine Filiale mit der ID "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"} |
Antwort
Schlüssel | Wert |
Status | Eine String, der den endgültigen Status des Exports beschreibt.
|
Warnungen | Er ist optional, d.h. er ist nur enthalten, wenn der Parameter ?debug in der URL enthalten ist und der Export mindestens eine Warnung erzeugt hat. Liste der Warnstrings. |
Fehler | Optional - nur enthalten, wenn der Export mindestens einen Fehler erzeugt hat. Liste der Fehlerstrings. |
Total Zeilen | Optional - wird nur angegeben, wenn der Export nicht mit dem Status "FAILURE" beendet wurde. Anzahl der Datensätze auf dem Input |
Ignorierte Produkte | Optional - nur enthalten, wenn der Export nicht mit dem Status "FAILURE" abgeschlossen wurde Die Anzahl der Produkte vom Input, die nicht exportiert wurden. Mögliche Gründe sind:
|
Status Codes
Status | Wert |
200 OK | Export 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 Autorisierungs-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 Exports ist ein kritischer serverseitiger Fehler aufgetreten. |
503 Service Unavailable | Die Aufgabe läuft bereits. Der Start der Aufgabe wird nach der im Antwort-Header Retry-After angegebenen Anzahl von Sekunden erneut versucht. |
Ausführungs-Log
In Quant können Sie zusätzlich zu den Aufgabeneinstellungen auch Datensätze zu einzelnen Exporten, einschließlich Statistiken, Fehlern und Warnungen, anzeigen.
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/export/store-specific-product-data/149?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d '[{ "Store ID": "12564"}]'
Antwort
{
"Status": "SUCCESS", "Records": [
{"Filial-ID": "12564", "Primäre Produkt-ID": "100001", "Stock": "12"},
{"Filial-ID": "12564", "Primäre Produkt-ID": "100005", "Stock": "0"},
... ]
}