Dieser Artikel beschäftigt sich mit den Integrationsmöglichkeiten von Herstellerverfügbarkeiten. Hier steht zum einen die klassische Abfrage per JavaScript und zum anderen eine serverseitige Abfrage zur Verfügung.
Weitere Informationen zur serverseitigen Abfrage befinden sich im Artikel Public API: Product Information. Die serverseitige Abfrage ermöglicht eine Suchmaschinen-optimierte (SEO) Integration. Darüber hinaus stehen Ihnen weitere Informationen im Artikel OXOMI Blink API zur Verfügung.
Die Integration per JavaScript hingegen ist eine einfache Möglichkeit, Herstellerverfügbarkeiten schnell und effektiv einzubinden. Die nachfolgende ausführliche Beschreibung der JavaScript-Integration setzt die im Artikel JavaScript Integrationsgrundlagen beschriebenen Grundlagen voraus. Der Artikel geht dabei insbesondere auf die Parameter (sowie deren Wertebereich) der vorhandenen Integrationsmöglichkeiten ein und veranschaulicht diese jeweils in einem interaktiven Showcase.
Diese Integration erlaubt es, mittels der Funktion oxomi.productAvailability, Verfügbarkeitsinformationen für spezifizierte Produkt abzufragen. OXOMI greift dabei auf einen vom Hersteller bereitgestellten Webservice zu, um die angefragten Verfügbarkeiten zu ermitteln. Optional kann für jedes Produkt eine Menge und eine Einheit angegeben werden. Beachten Sie, dass die Auswertung dieser Informationen in der Verantwortung des Herstellers liegt. OXOMI leitet die Informationen lediglich weiter.
Der Aufruf der Integration liefert ein Promise zurück, welches Ihnen die Möglichkeit gibt, entsprechend auf den Abschluss des Aufrufs zu reagieren. Hierfür können Sie die then und catch Methoden des Promise Objekts verwenden. Der nachfolgende JavaScript-Code zeigt ein Beispiel, wie Sie auf den Abschluss des Aufrufs reagieren können.
oxomi.productAvailability({ itemNumber: "", supplierNumber: "", quantity: 10 }).then((result) => { console.log("success"); }).catch((error) => { console.log("failed"); });
Das im then-Fall zurückgegebene result-Objekt enthält die im Artikel OXOMI Blink API beschriebenen Felder.
Die nachfolgende Tabelle enthält eine Übersicht über die verfügbaren Parameter. Fett gedruckte Parameter sind Pflichtparameter. Die Beschreibung der Parameter enthält Informationen über den Typ des Parameters, die möglichen Werte und die Bedeutung sowie weitere Verwendungshinweise.
Parameter | Parametertyp | Beschreibung |
---|---|---|
itemNumber | string |
Gibt die Artikelnummer des Produkts an, für welches die Herstellerverfügbarkeit abgerufen werden soll. |
supplierNumber | string |
Gibt die Nummer des Lieferanten an, über welchen das Produkt bezogen wird. Hinweis:
|
quantity | number | Definiert die Anzahl der Artikel. Als Wert wird hier eine positive Ganzzahl größer 0 erwartet. |
unit | string | Definiert die Einheit der Anzahl der Artikel (Mengeneinheit). Diese Werte können Sie hier einsehen. |
cached | boolean | Definiert, ob die Herstellerverfügbarkeitsinformationen aus dem Cache bezogen werden dürfen. Als Wert wird hier entweder true oder false erwartet. Bei true wird die Verfügbarkeit aus dem Cache abgerufen. |
Die Lieferantennummer (supplierNumber) dient dazu, die Anfrage zu gruppieren und an die richtigen Hersteller zu senden. Daher ist es wichtig, dass die Lieferantennummern in den Partnerschaften ordnungsgemäß gepflegt werden. Wenn keine Lieferantennummer in den Partnerschaften angegeben wird, wird die Anfrage für die eigenen Produkte des Mandanten ausgeführt.
Pro Aufruf können Herstellerverfügbarkeitsinformationen für bis zu 100 Produkte angefordert werden. Hierfür muss an die artikelbezogenen Parameter (itemNumber, supplierNumber, quantity und unit) ein ganzzahliger Suffix angehängt werden. Dieser beginnt bei 1 und erhöht sich mit jedem weiteren Artikel um 1. Das nachfolgende Beispiel veranschaulicht diesen Zusammenhang.
const apiParams = {}; // Data for the first article apiParams.itemNumber1 = "0000001"; apiParams.supplierNumber1 = "SP_0000001"; apiParams.quantity1 = 10; apiParams.unit1 = PCE; // Data for the second article apiParams.itemNumber2 = "0000002"; apiParams.supplierNumber2 = "SP_0000002"; // Data for the third article apiParams.itemNumber3 = "0000003"; apiParams.supplierNumber3 = "SP_0000003"; apiParams.quantity3 = 1; apiParams.unit3 = PCE; // Common Data apiParams.cached = true; oxomi.productAvailability(apiParams).then((result) => { // The 'result' object contains the availability information for all three articles console.log("success"); }).catch((error) => { console.log("failed"); });