REST API Produktverpackungen Import V1

Dieser Quellcode wird für den Import von Produktpackungen 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.

Aufgaben-ID
  • 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 Produktpaketattribute Zuordnung 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
Maßeinheit
Maßeinheit wie cm, mm usw.
Auswahl
Datumsformat
Datumseingabeformat, z.B. 31.12.19
Auswahl
Datum und Zeitformat
Format für die Eingabe von Datum und Uhrzeit, z.B. 19.12.31 23:59:59
Auswahl
Matching Attribute
Ein Produktattribut in Quant, das verwendet wird, um Importartikel mit Produkten in Quant abzugleichen.
Auswahl
Neue Produkte erstellen
Wenn aktiviert, werden beim Import neue Produkte für nicht vorhandene Produkt-IDs erstellt.
ja/nein
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.
ja/nein
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 wieder aktiviert. Wenn Sie diese Option aktivieren, werden gelöschte Produkte ignoriert und nicht wiederhergestellt.
ja/nein
Nicht-Null-Messungen nicht überschreiben
Wenn aktiviert, werden Abmessungen aus importierten Datensätzen (z. B. Höhe, Breite) nur dann importiert, wenn das vorhandene Paket keine Abmessungen aufweist.
ja/nein
Entferne nicht aktualisierte Packungen
Wenn aktiviert, werden Packungen gelöscht, die nicht durch einen Eintrag aktualisiert wurden. Gilt nur für Produkte, die in diesem Import enthalten sind.
ja/nein
Nur leere Packungen entfernen
Löscht, wenn aktiviert, nur leere Packungen, die nicht aktualisiert wurden, d.h. Packungen mit leerem Namen und null Dimensionen.
ja/nein
Produktpaket Attribut-Mapping
Ein Mapping mit einem Eintrag für jedes zu importierende Attribut.
komplexer Typ


Einstellungen
  • Anfrage

/v1/import/product-packages/{task_id}

Parameter
Wert
URL
?debug, das der URL hinzugefügt wird, zeigt auch Warnungen in der Antwort an. Ohne diese Option werden nur Fehler angezeigt.
Kopfzeile
Accept: application/json
Kopfzeile
Inhaltstyp: application/json
Kopfzeile

Berechtigung: Bearer  <TOKEN>

TOKEN se získává pomocí /authenticate (siehe Login).

Methode
POST

Der Inhalt der Anfrage ist ein Array von JSON-Objekten mit den Schlüsseln, die in der Einstellung für die Zuordnung von Produktpaketen zu Attributen definiert sind.

  • Antwort
Schlüssel
Wert
Status
Eine Zeichenfolge, die den endgültigen Zustand des Imports beschreibt.
  • SUCCESS = fehlerfreier Importvorgang
  • PARTIAL_SUCCESS = Import abgeschlossen, aber eine oder mehrere Warnungen erzeugt
  • FAILURE = ein oder mehrere Fehler sind während des Imports aufgetreten
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 wurde
Anzahl der eingegebenen Datensätze
Duplizierte Pakete
Optional - wird nur eingefügt, wenn der Import nicht mit dem Status "FAILURE"
beendet wurde
Die Anzahl der Datensätze, die übersprungen wurden, weil dieses Paket bereits im selben Auftrag importiert wurde.
Ingnorierte Produkte
Optional - Nur enthalten, wenn der Import nicht mit dem Status "FAILURE" 
beendet wurde
Anzahl der Eingabeprodukte, für die keine Produktpakete importiert wurden. Mögliche Gründe sind:
  • Nicht existierende Produkt-ID und Erstellung neuer Produkte deaktiviert
  • Die Produkt-ID wurde unter den gelöschten Produkten gefunden und das Ignorieren gelöschter Produkte ist eingeschaltet
  • 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.

Ausführungsprotokoll

Wenn wir einen bestimmten Datensatz auswählen, können wir seine Details anzeigen, indem wir auf die Schaltfläche Elemente anzeigen klicken.

Elemente anzeigen 


  • Anfrage

curl -X POST --location "https://[IHR_COMPANY].iquant.eu/v1/import/product-packages/28?debug" \

    -H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \

    -H "Accept: application/json" \

      -H "Content-Type: application/json" \

    -H "Cache-Control: no-cache" \

-d '[{ "Primäre Produkt-ID": "100001", "Verpackung": "Testpaket", "Breite": 10.5, "Höhe": 3, "Depth": 0.4 }]'

  • Antwort

{

  "Status": "SUCCESS", 

  "Total Lines": 1,

  "Doppelte Produkte": 0,

  "Ignorierte Produkte": 0

}