Catalog

In order to retrieve productdata from OIS, the Catalog endpoints can be used. There are related endpoints which need to be used in order to retrieve additional information, which will also be mentioned here.

Products and Variants

In the Catalog endpoints there are products, which always have one or more variants.

Both products and variants have unique Identifiers (GUID/UUID). It is recommended that these identifiers are used as main synchronisation key to ensure consistency between all systems.

Properties

Properties, also known as Components or Attributes, can be linked to both products and variants. Properties always have a TypeId, signifying which group a property belongs to.

In order to retrieve properties the following endpoints are needed:

• The endpoint to retrieve the link between Product and Properties is v1/ProductProperties GET

• The endpoint to retrieve the link between Variant and Properties is v1/VariantProperties GET

• The endpoint to retrieve Properties is v1/Properties GET

• The endpoint to retrieve PropertyTypes is v1/PropertyTypes GET

Categories

Categories are always linked to products. Note that categories can have a parent-child relation and all related categories are also returned per product in the catalog endpoints.

Categories are linked by Id from the catalog to its endpoint:

• The endpoint to retrieve categories is v1/Category GET.

ArticleGroups

ArticleGroups are always linked to products. Note that articlegroups have a relation inherent to articlegroup codes and only the product's articlegroup is returned in the catalog endpoints.

ArticleGroups are linked by Id from the Catalog to its endpoint:

• The endpoint to retrieve ArticleGroups is v1/ArticleGroup GET.

Images

If an image is linked to a variant in OIS, the main image url will be returned in the catalog endpoints. However, OIS will also generate 12 thumbnails to ensure these are always available for use in webshops/platforms/applications. In order to use the thumbnails, these can be derived from the main image url in a consistent manner.

The main image url consists of two parts:

• {BaseUrl} + /{tenant}/images/products/{articlenumber}_{code}_{index}.{extension}

From the main image url, the thumbnail urls can be derived as follows:

• Main image = {BaseUrl}/{tenant}/images/products/{articlenumber}_{code}_{index}.{extension}

• Thumbnail = {BaseUrl}/{tenant}/images/thumbs/{articlenumber}_{code}_{index}_{thumbnail size}.{extension}

The following thumbnail sizes are available:

• 50x50

• 100x100

• 200x200

• 300x300

• 400x400

• 500x500

• 800x800

• 1000x1000

• 1200x1200

• 1400x1400

• 1600x1600

• 2000x2000