Integrating item-based data

Data sheet

To load OXOMI’s fact sheet, use the function oxomi.itemDatasheet.

This function is responsible for loading an item’s entire data sheet. It includes reference data, images, files, long texts, document pages, videos and galleries of an item.

Parameter	Description
target	Indicates the target element, in which the fact sheet will be displayed. If this parameter is not provided, `#oxomi-datasheet` is chosen as a default value.
supplierItemNumber	Provides the item number or manufacturer number that is used for the search.
supplierNumber	Provides the item’s supplier number. If no supplier number is indicated, only your personal brand is included in the search while other brands are excluded. If you wish to use supplier numbers, make sure they are recorded in OXOMI.
tag	Defines the tag that used to filter the contents. If you have more than one tag, insert a comma between each tag.
videoMode	`overlay`: Open in an overlay `in-place`: Display player directly in site
includeOutdated	Assign the value `true` to this parameter if archived document pages, videos and galleries are supposed to be displayed as well.
onlyOutdated	If `true`, only archived document pages, videos and galleries will get displayed. This parameter overwrites the parameter `includeOutdated`.
fullWidthHeading	If `true`, the heading featuring the item number will be displayed in full width. Otherwise, the heading only shows up above the reference data.
showItemGroups	If `true`, the item’s groups (product group, discount group, …) are displayed. If no value is provided, the value in the design portal settings is used.

The following parameters can only be used with a PRO portal:

Parameter	Description
lang	Defines the language (using a two letter ISO-Code) that is used to filter the contents.
country	Defines the country (using a two letter ISO-Code) that is used to filter the contents.

Example:

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

Data sheet download

Use the function oxomi.downloadItemDatasheet to generate a download link for a data sheet (pdf).

Parameter	Description
target	Indicates the target element, in which the fact sheet will be displayed. If this parameter is not provided, `#oxomi-download-datasheet` is chosen as a default value.
supplierItemNumber	Provides the item number or manufacturer number that is used for the search.
supplierNumber	Provides the item’s supplier number. If no supplier number is indicated, only your personal brand is included in the search while other brands are excluded. If you wish to use supplier numbers, make sure they are recorded in OXOMI.
tag	Defines the tag that used to filter the contents. If you have more than one tag, insert a comma between each tag.
linkOnly	If `true`, the `target`’s content isn’t replaced and the search for an existing link takes place. In the case of a found link, the link’s `href` attribute is overwritten by the pdf download link.

The following parameters can only be used with a PRO portal:

Parameter	Description
lang	Defines the language (using a two letter ISO-Code) that is used to filter the contents.
country	Defines the country (using a two letter ISO-Code) that is used to filter the contents.

Example:

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

Item images

Use the function oxomi.itemImages to load images via OXOMI.

This function makes it possible to load one or multiple images for a specific item. If no matching image is found, the HTML isn’t altered. That way it is possible to load as much images as possible through OXOMI (improved bandwidth, higher resolution, automated management) while having the option to fall back to a pool of own pictures.

Parameter	Description
target	Indicates the target element, in which the fact sheet will be displayed. If this parameter is not provided, `#oxomi-images` is chosen as a default value.
supplierItemNumber	Provides the item number or manufacturer number that is used for the search.
supplierNumber	Provides the item’s supplier number. If no supplier number is indicated, only your personal brand is included in the search while other brands are excluded. If you wish to use supplier numbers, make sure they are recorded in OXOMI.
tag	Defines the tag that used to filter the contents. If you have more than one tag, insert a comma between each tag.
type	Defines the image type that is used to filter the images. Make sure to use the appropriate type codes. Here’s a list of the available image types. `\|` is supported as a separator of multiple image types.

The following parameters can only be used with a PRO portal:

Parameter	Description
lang	Defines the language (using a two letter ISO-Code) that is used to filter the contents.
country	Defines the country (using a two letter ISO-Code) that is used to filter the contents.

Example:

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

Item thumbnail

If you want to include item thumbnails, use our public API to do so. You can generate a URL which gives you direct access to the item’s thumbnail.

Head to the section public API for detailed descriptions.

Item attachments

Use the function oxomi.itemAttachments to load OXOMI’s file attachments.

This function makes it possible to load one or multiple data files (CAD drawings, fact sheets, calculation aids) for an item. If no matching files are found, the HTML isn’t altered.

Parameter	Description
target	Indicates the target element, in which the fact sheet will be displayed. If this parameter is not provided, `#oxomi-attachments` is chosen as a default value.
supplierItemNumber	Provides the item number or manufacturer number that is used for the search.
supplierNumber	Provides the item’s supplier number. If no supplier number is indicated, only your personal brand is included in the search while other brands are excluded. If you wish to use supplier numbers, make sure they are recorded in OXOMI.
tag	Defines the tag that used to filter the contents. If you have more than one tag, insert a comma between each tag.
type	Defines the file type that is used to filter. Make sure to use the appropriate type codes. Here’s a list of the available file types. `\|` is supported as a separator of multiple file types.

The following parameters can only be used with a PRO portal:

Parameter	Description
lang	Defines the language (using a two letter ISO-Code) that is used to filter the contents.
country	Defines the country (using a two letter ISO-Code) that is used to filter the contents.

Example:

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

Item long text

Use the function oxomi.itemText to load long texts via OXOMI.

This function makes it possible to retrieve long texts (e.g. item descriptions or tender texts) for an item.

Parameter	Description
target	Indicates the target element, in which the fact sheet will be displayed. If this parameter is not provided, `#oxomi-text` is chosen as a default value.
supplierItemNumber	Provides the item number or manufacturer number that is used for the search.
supplierNumber	Provides the item’s supplier number. If no supplier number is indicated, only your personal brand is included in the search while other brands are excluded. If you wish to use supplier numbers, make sure they are recorded in OXOMI.
tag	Defines the tag that used to filter the contents. If you have more than one tag, insert a comma between each tag.
type	Defines the text type that is used to filter. Make sure to use the appropriate type codes. Here’s a list of the available text types. `\|` is supported as a separator of multiple image types.

The following parameters can only be used with a PRO portal:

Parameter	Description
lang	Defines the language (using a two letter ISO-Code) that is used to filter the contents.
country	Defines the country (using a two letter ISO-Code) that is used to filter the contents.

Example:

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

Item references

Use the function oxomi.itemReferences to inquire the relations between your items. Among others, item relations include “accessories”, “cross selling” and “up-selling”.

Parameter	Description
target	Indicates the target element, in which the fact sheet will be displayed. If this parameter is not provided, `#oxomi-references` is chosen as a default value.
supplierItemNumber	Provides the item number or manufacturer number that is used for the search.
supplierNumber	Provides the item’s supplier number. If no supplier number is indicated, only your personal brand is included in the search while other brands are excluded. If you wish to use supplier numbers, make sure they are recorded in OXOMI.
type	Defines the relation type that is used to filter. Make sure to use the appropriate type codes.
limit	Limits the amount of displayed results. The default value is `5000` (max. `10000`).

Item reference types

The following list shows all available types of item relations and the associated codes that are used in the integration:

Type	Code
Other	other
Accessory	accessory
Base product	base_product
Successor	followup
Required additional product	mandatory
Similar product	similar
Spare part	sparepart
Set component	set_component
Cross-Selling	cross_selling
Up-Selling	up_selling

The following parameters can only be used with a PRO portal:

Parameter	Description
lang	Defines the language (using a two letter ISO-Code) that is used to filter the contents.
country	Defines the country (using a two letter ISO-Code) that is used to filter the contents.

Example:

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

Back to overview