This API specification is available for download as an Open API 3.0 YAML file:
The following page lists available REST APIs for ICM 7.10 and their version dependencies:
The Intershop Product & Category REST API contains resources for retrieving a wide range of product-related information as well as category information and product filters.
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.
The new /productfilters
endpoint replaces the deprecated /filters
endpoint.
The /products
endpoint returns available products. The results can be filtered by search term and product filters.
The /categories/{categoryID}/products
endpoint returns available products for a specific category. The results can be filtered by search term, product filters and predefined product filters (via the productFilter query parameter).
The /productfilters
endpoint is used to fetch said filters and filter entries.
The interaction between these endpoints is illustrated in the following sections:
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
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.
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.
If the product SKU uses special characters ("/", ":", ...), then it needs to be double encoded.
The SKU in the links in the responses are also double encoded, so they may be directly used.
Example
product: Using double encoding for a/b
, it becomes a%252Fb
.
Open ReDoc-rendered Open API documentation in separate window.