Allgemeines

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.

Herstellerverfügbarkeiten

Diese Integration erlaubt es, mittels der Funktion checkAvailability, 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.

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:

  • Wenn eigene Produkte angezeigt werden sollen, kann hier ein - eingetragen werden.
  • Sie können Ihre eigenen Lieferantennummern verwenden, wenn Sie diese in der Partnerschaft zum Lieferanten gepflegt haben (siehe: Lieferantennummern).
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.
callback function Definiert eine Callback-Funktion, welche mit den Herstellerverfügbarkeitsinformationen aufgerufen wird, sobald diese verfügbar sind. Der Callback-Funktion wird ein JSON-Objekt übergeben, welches die im Artikel OXOMI Blink API beschriebenen Felder enthält.

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;
apiParams.callback = (response) => { console.log(response) };

oxomi.checkAvailability(apiParams);

Herstellerverfügbarkeiten - Showcase

Initialisierungsparameter
(portal)
Bitte geben Sie hier den Portal-Code beziehungsweise die Portal-ID an. Hier finden Sie weitere Informationen.
(user) Bitte geben Sie hier den Benutzernamen eines Portalbenutzers ein. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
(roles) Bitte geben Sie hier wahlweise die Portallrollen an, um den Zugriff auf die Inhalte zu steuern. Hier finden Sie weitere Informationen.
(accessToken) Für die externe Authentifizierung kann ein im integrierenden System generierter Access-Token eingesetzt werden. Benutzen Sie den Access-Token Rechner, um Ihren individuellen Access-Token zu berechnen. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
Hauptparameter
(itemNumber) Gibt die Artikelnummer des Produkts an, für welches die Herstellerverfügbarkeit abgerufen werden soll.
(supplierNumber) Gibt die Nummer des Lieferanten an, über welchen das Produkt bezogen wird.
(quantity) Definiert die Anzahl der Artikel. Als Wert wird hier eine positive Ganzzahl größer 0 erwartet.
(unit)
Definiert die Einheit der Anzahl der Artikel (Mengeneinheit). Diese Werte stehen hier zur Verfügung: Mengeneinheiten
(cached) Definiert ob die Herstellerverfügbarkeitsinformationen aus dem Cache bezogen werden dürfen.

Ausgabebereich

Siehe auch
Enthält die Grundlagen zum Thema Javascript Integration.