Product & Catalog API

Personalized Content

The call can contain customer-segment specific details, e.g. prices.

If the spgid parameter is not provided, the cached version of the call is returned. Use the spgid parameter to retrieve a customer-segment specific version.

For authenticated REST calls, use the spgid parameter in the URL. Otherwise the request will be considered anonymous, even if authentication is provided in the header.

Example: /products;spgid=12345

Use the /personalization call to retrieve the spgid.

Product Filters

The new /productfilters endpoint replaces the deprecated /filters endpoint.

Using the Product Filters Endpoint

The /products endpoint returns available products. The results can be filtered by search term and product filters.
The /productfilters endpoint is used to fetch said filters and filter entries.
The interaction between these two endpoints is illustrated in the following sections:

Selection of Filter Entry

To start, fetch the available filters for a search term.

Example: /productfilters?searchTerm=camera fetches filters which are applicable for products matching the search term "camera".

The result list of the endpoint contains further filters that can be applied in addition to the current filters. They can be applied by using the URI provided in the link field.

Example: /productfilters?searchTerm=camera&Colour_of_product=Black applies the filter Colour_of_product=Black to the current query.

It is possible to select multiple entries for a filter. If an attribute is a multi-value, then combinations of these values are made available in the list of filter entries.

Example: /productfilters?searchTerm=camera&Colour_of_product=Black_or_Blue adds Blue to the filter.

It is also possible to deselect entries. If a filter entry is selected, its link field will provide a link to deselect this entry.
Example: /productfilters?searchTerm=camera&Colour_of_product=Blue

Retrieving Product Hits

To fetch the products that match the given search term and selected filters, use the link provided in the hits field.
The existing query parameters that apply to the product list endpoint may be added to this query.

Example: /categories/Cameras-Camcorders/products?searchTerm=camera&Colour_of_product=Black_or_Blue&amount=12 fetches a maximum of 12 products matching these filters in the Cameras-Camcorders category.

Navigation

The same filters can also be used when navigating through the category tree.

Example: /categories/Cameras-Camcorders/832/productfilters?productFilter=fallback_searchquerydefinition fetches filters that are available in the respective subcategory.