Einbinden artikelbezogener Daten

Datenblatt

Rufen Sie die Funktion oxomi.itemDatasheet auf um ein Datenblatt von OXOMI zu laden.

Diese Funktion ermöglicht es, ein komplettes Datenblatt für einen Artikel zu laden. Darin enthalten sind Stammdaten, Bilder, Dateien, Langtexte, Katalogseiten, Videos und Exposés zu einem Artikel.

Parameter	Beschreibung
target	Gibt das Ziel-Element an, in welches das Datenblatt eingefügt wird. Wird dieser Parameter nicht angegeben, so wird `#oxomi-datasheet` als Standard-Wert verwendet.
supplierItemNumber	Gibt die Artikel- oder Werksnummer an, nach der gesucht werden soll.
supplierNumber	Hiermit wird die artikelzugehörige Lieferantennummer festgelegt. Wird keine Lieferantennummer angegeben, so wird nur innerhalb der "Eigenmarke" gesucht und nicht markenübergreifend. Um Lieferantennummern verwenden zu können, müssen diese in OXOMI hinterlegt sein. Pflegen Sie Lieferantennummern über die Partnerschaft zum jeweiligen Lieferanten ( Lieferantennummern).
tag	Gibt einen Tag an, nach dem gefiltert werden soll. Geben Sie mehrere Tags durch Kommas getrennt an.
videoMode	`overlay`: In Overlay öffnen `in-place`: Player in Seite öffnen
includeOutdated	Belegen Sie diesen Parameter mit dem Wert `true`, damit auch archivierte Katalogseiten, Videos und Exposés angezeigt werden.
onlyOutdated	Falls `true`, werden nur archivierte Katalogseiten, Videos und Exposés angezeigt. Dieser Parameter überschreibt den Parameter `includeOutdated`.
fullWidthHeading	Falls `true`, wird die Überschrift mit der Artikelnummer über die ganze Breite angezeigt. Sonst wird die Überschrift mit der Artikelnummer nur über den Stammdaten angezeigt.
showItemGroups	Falls `true`, werden die Gruppierungen des Artikels (Warengruppe, Rabattgruppe, ...) angezeigt. Wird kein Wert angegeben, wird der Wert aus den Design-Portaleinstellungen verwendet.

Nachfolgende Parameter sind nur für PRO Portale verfügbar:

Parameter	Beschreibung
lang	Gibt die Sprache (als 2-buchstabigen ISO-Code) an, nach der gefiltert werden soll.
country	Gibt das Land (als 2-buchstabigen ISO-Code) an, nach dem gefiltert werden soll.

Beispiel:

oxomi.itemDatasheet({ target: '#custom-datasheet-container'
                      supplierNumber: 'L10190',
                      supplierItemNumber: 'A20876',
                      videoMode: 'overlay',
                      classMap: {
                        '.oxomi-link': '.custom-css-class'
                      },
                      includeOutdated: true });

Datenblatt-Download

Rufen Sie die Funktion oxomi.downloadItemDatasheet auf um einen Download-Link für ein PDF-Datenblatt zu generieren.

Parameter	Beschreibung
target	Gibt das Ziel-Element an, in welches der Download-Link eingefügt wird. Wird dieser Parameter nicht angegeben, so wird `#oxomi-download-datasheet` als Standard-Wert verwendet.
supplierItemNumber	Gibt die Artikel- oder Werksnummer an, nach der gesucht werden soll.
supplierNumber	Hiermit wird die artikelzugehörige Lieferantennummer festgelegt. Wird keine Lieferantennummer angegeben, so wird nur innerhalb der "Eigenmarke" gesucht und nicht markenübergreifend. Um Lieferantennummern verwenden zu können, müssen diese in OXOMI hinterlegt sein. Pflegen Sie Lieferantennummern über die Partnerschaft zum jeweiligen Lieferanten ( Lieferantennummern).
tag	Gibt einen Tag an, nach dem gefiltert werden soll. Geben Sie mehrere Tags durch Kommas getrennt an.
linkOnly	Falls `true`, wird der Inhalt im `target` nicht ersetzt, sondern ein vorhandener Link gesucht und dessen `href`-Attribut mit dem PDF-Download-Link überschrieben.

Nachfolgende Parameter sind nur für PRO Portale verfügbar:

Parameter	Beschreibung
lang	Gibt die Sprache (als 2-buchstabigen ISO-Code) an, nach der gefiltert werden soll.
country	Gibt das Land (als 2-buchstabigen ISO-Code) an, nach dem gefiltert werden soll.

Beispiel:

oxomi.downloadItemDatasheet({ supplierNumber: 'L10190',
                              supplierItemNumber: 'A20876',
                              lang: 'de',
                              country: 'ch' });

Bilder zu einem Artikel

Rufen Sie die Funktion oxomi.itemImages auf um Bilder von OXOMI zu laden.

Diese Funktion ermöglicht es, ein oder mehrere Abbildungen für einen Artikel zu laden. Sollte kein passendes Bild gefunden werden, so wird das HTML nicht verändert. Dies ermöglicht es möglichst viele Bilder über OXOMI zu laden (bessere Bandbreite, hohe Auflösungen, automatische Pflege) und trotzdem auf den eigenen Bildbestand zurückgreifen zu können.

Parameter	Beschreibung
target	Gibt das Ziel-Element an, in welches die gefundenen Bilder eingefügt werden. Wird dieser Parameter nicht angegeben, so wird `#oxomi-images` als Standard-Wert verwendet.
supplierItemNumber	Gibt die Artikel- oder Werksnummer an, für die ein Bild gesucht werden soll.
supplierNumber	Hiermit wird die artikelzugehörige Lieferantennummer festgelegt. Wird keine Lieferantennummer angegeben, so wird nur innerhalb der "Eigenmarke" gesucht und nicht markenübergreifend. Um Lieferantennummern verwenden zu können, müssen diese in OXOMI hinterlegt sein. Pflegen Sie Lieferantennummern über die Partnerschaft zum jeweiligen Lieferanten ( Lieferantennummern).
tag	Gibt einen Tag an, nach dem gefiltert werden soll. Geben Sie mehrere Tags durch Kommas getrennt an.
type	Gibt den Bild-Typ an, nach dem gefiltert werden soll. Verwenden Sie hier die entsprechenden Typen-Codes. Hier finden Sie eine Liste der verfügbaren Bild-Typen. Als Trennzeichen mehrerer Bild-Typen wird `\|` unterstützt.
textOriginal	Gibt einen Text an, der als Hinweis angezeigt werden soll, wenn es sich bei einem Bild um die genaue Abbildung des Artikels handelt. Wird dieser Parameter nicht übergeben wird kein Hinweis angezeigt.
textSubstitute	Gibt einen Text an, der als Hinweis angezeigt werden soll, wenn es sich bei einem Bild um die Abbildung eines Stellvertreters des Artikels handelt. Wird dieser Parameter nicht übergeben wird kein Hinweis angezeigt.

Nachfolgende Parameter sind nur für PRO Portale verfügbar:

Parameter	Beschreibung
lang	Gibt die Sprache (als 2-buchstabigen ISO-Code) an, nach der gefiltert werden soll.
country	Gibt das Land (als 2-buchstabigen ISO-Code) an, nach dem gefiltert werden soll.

Beispiel:

oxomi.itemImages({ supplierNumber: 'L10190',
                   supplierItemNumber: 'A20876',
                   textSubstitute: 'Abbildung ähnlich' });

Vorschaubild eines Artikels

Sollten Sie Vorschaubilder zu Artikeln einbinden wollen, dann nutzen Sie hierfür die Öffentliche API. Sie können eine URL erzeugen mit der Sie direkt auf das Vorschaubild eines Artikels zugreifen können.

Eine detaillierte Beschreibungen finden Sie im Kapitel Öffentliche API.

Dateien zu einem Artikel

Rufen Sie die Funktion oxomi.itemAttachments auf, um Dateianhänge von OXOMI zu laden.

Diese Funktion ermöglicht es, ein oder mehrere Dateien (CAD-Zeichnungen, Datenblätter, Kalkulationshilfen) für einen Artikel zu laden. Sollte keine passenden Dateien gefunden werden, so wird das HTML nicht verändert.

Parameter	Beschreibung
target	Gibt das Ziel-Element an, in welches die gefundenen Dateien eingefügt werden. Wird dieser Parameter nicht angegeben, so wird `#oxomi-attachments` als Standard-Wert verwendet.
supplierItemNumber	Gibt die Artikel- oder Werksnummer an, für die Dateien gesucht werden sollen.
supplierNumber	Hiermit wird die artikelzugehörige Lieferantennummer festgelegt. Wird keine Lieferantennummer angegeben, so wird nur innerhalb der "Eigenmarke" gesucht und nicht markenübergreifend. Um Lieferantennummern verwenden zu können, müssen diese in OXOMI hinterlegt sein. Pflegen Sie Lieferantennummern über die Partnerschaft zum jeweiligen Lieferanten ( Lieferantennummern).
tag	Gibt einen Tag an, nach dem gefiltert werden soll. Geben Sie mehrere Tags durch Kommas getrennt an.
type	Gibt den Datei-Typ an, nach dem gefiltert werden soll. Verwenden Sie hier die entsprechenden Typen-Codes. Hier finden Sie eine Liste der verfügbaren Datei-Typen.

Nachfolgende Parameter sind nur für PRO Portale verfügbar:

Parameter	Beschreibung
lang	Gibt die Sprache (als 2-buchstabigen ISO-Code) an, nach der gefiltert werden soll.
country	Gibt das Land (als 2-buchstabigen ISO-Code) an, nach dem gefiltert werden soll.

Beispiel:

oxomi.itemAttachments({ supplierNumber: 'L10190',
                        supplierItemNumber: 'A20876' });

Langtext zu einem Artikel

Rufen Sie die Funktion oxomi.itemText auf, um Langtexte von OXOMI zu laden.

Diese Funktion ermöglicht es, Langtexte wie beispielweise eine Artikelbeschreibung oder einen Ausschreibungstext für einen Artikel abzufragen.

Parameter	Beschreibung
target	Gibt das Ziel-Element an, in welches der gefundene Text eingefügt wird. Wird dieser Parameter nicht angegeben, so wird `#oxomi-text` als Standard-Wert verwendet.
supplierItemNumber	Gibt die Artikel- oder Werksnummer an, für die der Langtext gesucht werden sollen.
supplierNumber	Hiermit wird die artikelzugehörige Lieferantennummer festgelegt. Wird keine Lieferantennummer angegeben, so wird nur innerhalb der "Eigenmarke" gesucht und nicht markenübergreifend. Um Lieferantennummern verwenden zu können, müssen diese in OXOMI hinterlegt sein. Pflegen Sie Lieferantennummern über die Partnerschaft zum jeweiligen Lieferanten ( Lieferantennummern).
tag	Gibt einen Tag an, nach dem gefiltert werden soll. Geben Sie mehrere Tags durch Kommas getrennt an.
type	Gibt den Text-Typ an, nach dem gefiltert werden soll. Verwenden Sie hier die entsprechenden Typen-Codes. Hier finden Sie eine Liste der verfügbaren Text-Typen. Als Trennzeichen mehrerer Text-Typen wird `\|` unterstützt.

Nachfolgende Parameter sind nur für PRO Portale verfügbar:

Parameter	Beschreibung
lang	Gibt die Sprache (als 2-buchstabigen ISO-Code) an, nach der gefiltert werden soll.
country	Gibt das Land (als 2-buchstabigen ISO-Code) an, nach dem gefiltert werden soll.

Beispiel:

oxomi.itemText({ supplierNumber: 'L10190',
                 supplierItemNumber: 'A20876',
                 type: 'description' });

Stammdaten zu einem Artikel

Rufen Sie die Funktion oxomi.itemMasterdata auf um Stammdaten von OXOMI zu laden.

Parameter	Beschreibung
target	Gibt das Ziel-Element an, in welches die Stammdaten eingefügt werden. Wird dieser Parameter nicht angegeben, so wird `#oxomi-masterdata` als Standard-Wert verwendet.
supplierItemNumber	Gibt die Artikel- oder Werksnummer an, nach der gesucht werden soll.
supplierNumber	Hiermit wird die artikelzugehörige Lieferantennummer festgelegt. Wird keine Lieferantennummer angegeben, so wird nur innerhalb der "Eigenmarke" gesucht und nicht markenübergreifend. Um Lieferantennummern verwenden zu können, müssen diese in OXOMI hinterlegt sein. Pflegen Sie Lieferantennummern über die Partnerschaft zum jeweiligen Lieferanten ( Lieferantennummern).
tag	Gibt einen Tag an, nach dem gefiltert werden soll. Geben Sie mehrere Tags durch Kommas getrennt an.
type	Gibt den Artikel-Typ an, nach dem gefiltert werden soll. Verwenden Sie hier die entsprechenden Typen-Codes.
showItemGroups	Falls `true` werden die Gruppierungen des Artikels (Warengruppe, Rabattgruppe, ...) angezeigt. Wird kein Wert angegeben, wird der Wert aus den Design-Portaleinstellungen verwendet.
showItemStateIndicator	Falls `true` werden Auslaufartikel (Mit Zustand Abverkauf oder Inaktiv) als solche über einen Hinweis direkt neben der Artikelnummer gekennzeichnet.

Nachfolgende Parameter sind nur für PRO Portale verfügbar:

Parameter	Beschreibung
lang	Gibt die Sprache (als 2-buchstabigen ISO-Code) an, nach der gefiltert werden soll.
country	Gibt das Land (als 2-buchstabigen ISO-Code) an, nach dem gefiltert werden soll.

Artikel-Typen

Die nachfolgendende Liste zeigt alle verfügbaren Artikel-Typen und die dazugehörigen Codes für die Verwendung in der Integration:

Typ	Code
Produkt	product
Ersatzteil	spare
Dienstleistung	service
Set	set
Zubehör	accessory
Sonstige	other

Beispiel:

oxomi.itemMasterdata({ target: '#custom-masterdata-container'
                      supplierNumber: 'L10190',
                      supplierItemNumber: 'A20876',
                      showItemGroups: true });

Artikelbeziehungen

Nutzen Sie die Funktion oxomi.itemReferences, um Beziehungen zwischen Ihren Artikeln abzufragen. Artikelbeziehungen sind unter anderem "Zubehör", "Cross-Selling" oder "Up-Selling" Artikel.

Parameter	Beschreibung
target	Gibt das Ziel-Element an, in welches die gefundenen Dateien eingefügt werden. Wird dieser Parameter nicht angegeben, so wird `#oxomi-references` als Standard-Wert verwendet.
supplierItemNumber	Gibt die Artikel- oder Werksnummer an, für die Beziehungen gesucht werden sollen.
supplierNumber	Hiermit wird die artikelzugehörige Lieferantennummer festgelegt. Wird keine Lieferantennummer angegeben, so wird nur innerhalb der "Eigenmarke" gesucht und nicht markenübergreifend. Um Lieferantennummern verwenden zu können, müssen diese in OXOMI hinterlegt sein. Pflegen Sie Lieferantennummern über die Partnerschaft zum jeweiligen Lieferanten ( Lieferantennummern).
type	Gibt den Artikelbeziehung-Typ an, nach dem gefiltert werden soll. Verwenden Sie hier die entsprechenden Typen-Codes.
limit	Begrenzt die Anzahl der angezeigten Ergebnisse. Standard-Wert ist `5000` (max. `10000`)

Artikelbeziehung-Typen

Die nachfolgendende Liste zeigt alle verfügbaren Artikelbeziehung-Typen und die dazugehörigen Codes für die Verwendung in der Integration:

Typ	Code
Sonstige	other
Zubehör	accessory
Basisartikel	base_product
Nachfolger	followup
Notwendiger Zusatzartikel	mandatory
Ähnlicher Artikel	similar
Ersatzteil	sparepart
Set-Bestandteil	set_component
Cross-Selling	cross_selling
Up-Selling	up_selling

Nachfolgende Parameter sind nur für PRO Portale verfügbar:

Parameter	Beschreibung
lang	Gibt die Sprache (als 2-buchstabigen ISO-Code) an, nach der gefiltert werden soll.
country	Gibt das Land (als 2-buchstabigen ISO-Code) an, nach dem gefiltert werden soll.

oxomi.itemReferences({ supplierNumber: 'L10190',
                       supplierItemNumber: 'A20876',
                       type: 'accessory' });

Zurück zur Übersicht