REST API Verkaufsimport V1
Dieser Quellcode wird für den Import von Verkaufsdaten in Quant verwendet. Eingabe- und Ausgabeformat ist JSON.
Benutzen Sie den Abschnitt Automatische Aufgaben , um einen Import zu erstellen und einzurichten. Nach der Erstellung hat 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:
- 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 Sales Attribute Mapping die zu importierenden Attribute aus und ändern Sie optional deren JSON-Schlüssel
Attribute
Attribut | Beschreibung | Typ |
Aktiviert | 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 |
Datumsformat | Datumseingabeformat, z.B. 31.12.19 | Auswahl |
Neue Produkte erstellen | Wenn aktiviert, erstellt der Import neue Produkte für nicht vorhandene Produkt-IDs. | yes/no |
Neue Produkte für Planogramming einstellen | Wenn diese Option aktiviert ist, werden neu erstellte Produkte zur Erstellung von Planogrammen entworfen. Diese Option ist nur aktiv, wenn Neue Produkte erstellen aktiviert ist. | yes/no |
Löschte Produkte ignorieren | Wenn der Import kein aktives Produkt für eine gegebene ID findet, sucht er standardmäßig unter den gelöschten Produkten. Findet er ein gelöschtes Produkt, wird es wiederbelebt. Wenn Sie diese Option aktivieren, werden gelöschte Produkte ignoriert und nicht wiederhergestellt. | yes/no |
Verkaufsattribut-Mapping | Ein Mapping, das einen Eintrag für die Produkt-ID, die Filial-ID, das Datum, die Buchungsart und jede Art von Verkauf enthält, die importiert werden soll. | komplexer Typ |
Anfrage
/v1/import/sales-data/{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 | Berechtigung: Bearer <TOKEN> TOKEN wird über /authenticate (siehe Login) bezogen. |
Methode | POST |
Der Inhalt der Anfrage ist ein Array von JSON-Objekten, die die in der Einstellung "Sales Attribute Mapping" definierten Schlüssel enthalten. Diese einzelnen Datensätze beschreiben Verkäufe für 1 Produkt, 1 Satz von Verkäufen, 1 Datum und 1 Buchungsart.
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. |
Gesamtzeilen | Optional - wird nur eingefügt, wenn der Import nicht mit dem Status "FAILURE" beendet wurdeAnzahl der eingegebenen Datensätze |
Erstellte Produkte | Optional - wird nur eingefügt, wenn der Import nicht mit dem Status "FAILURE" beendet wurdeAnzahl der durch den Import erzeugten Produkte. |
Ingnorierte Produkte | Optional - Nur enthalten, wenn der Import nicht mit dem Status "FAILURE" beendet wurdeAnzahl der Eingangsprodukte, für die keine Verkäufe importiert wurden. Mögliche Gründe sind:
|
Geänderte Zahlen | Optional - wird nur eingefügt, wenn der Import nicht mit dem Status "FAILURE" beendet wurdeAnzahl der durch den Import geänderten Datensätze. |
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 | Ein kritischer serverseitiger Fehler ist während des Imports 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 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 Elemente anzeigen klicken.
Anfrage
curl -X POST --location "https://[IHR_UNTERNEHMEN].iquant.eu/v1/import/sales-data/22?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d '[\
{ \
"Datum": "30.1.21", \
"Produkt-ID" : "123", \
"Store Id": "2", \
"GP1": 1.1, \
"Verkaufte Stücke": 1 \
}, \
{ \
"Datum": "31.1.21", \
"Produkt-ID" : "123", \
"Store Id": "2", \
"GP1": 3.3, \
"Verkaufte Stücke": 3 \
} \
]'
Antwort
{
"Status": "SUCCESS",
"Gesamtzeilen": 2,
"Veränderte Zahlen": 2,
"Ignorierte Produkte": 0,
"Erstellte Produkte": 0
}