Related Documents
Document Properties
Kbid
29U777
Last Modified
23-Mar-2021
Added to KB
26-Jan-2021
Public Access
Everyone
Status
Online
Doc Type
References
Product
ICM 7.10

Reference - Product and Category API 1.2.0


Product Version

7.10

Product To Version


Status

final

Download Specification 

This API specification is available for download as an Open API 3.0 YAML file: 

References

The following page lists available REST APIs for ICM 7.10 and their version dependencies:

API Specification

Introduction

OpenAPI Version: 3.0.1
Product & Category Version: 1.2.0

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 /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:

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.

Product SKU

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.

Categories API

{loc}{cur}/categories/{categoriesKey}/links
GET: Returns category links of a category

Description

This operation returns a list of all products and categories which are assigned as links to the category.

It is possible to filter by link type and by product/category.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.CategoryLinksResource.getCategoryLinks(java.lang.String,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathcategoriesKeystringComputers/3001/222Required | The category path that includes the complete path from the catalog to the current category.
in querylinkTypestringaccessoryLimit the response to one link type.
in querytargetObjectstringproductLimit the response to either product or category results.

Response

200 - OK - The links for the given category.

ResourceCollectionROTypedLinkRO application/json

400 - Bad Request - The query parameters are invalid.

404 - Not Found - The category could not be found.

{loc}{cur}/categories/{categoriesKey}/products{spgid}/{productKey}/categories
GET: Returns categories of a product

Description

This operation returns a list of all categories to which the product is explicitly or dynamically assigned.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.ProductResource.getCategories()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in pathcategoriesKeystringComputers/3001/222Required | The category path that includes the complete path from the catalog to the current category.
in pathproductKeystring4841578Required | The product ID

Response

200 - OK - The categories of the given product.

ResourceCollectionROLinkRO application/json

404 - Not Found - The product could not be found.

{loc}{cur}/categories{spgid}
GET: Returns top-level categories or category tree

Description

This operation returns a list of all top-level categories (catalogs). The sorting is as defined in the ICM (manual or dynamic sorting).

Use the view parameter to retrieve the whole category tree. This can be used to render the shop's main navigation.

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.CategoryRO$CategoryCollectionRO com.intershop.sellside.rest.common.capi.resource.category.CategoryListResource.getCategory(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Boolean)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in queryimageViewstringfrontBy default the response contains images of all image views that are maintained for this product. To receive only images of a specific image view, provide an image view ID. The possible values depend on the Image Management configuration in the ICM.

Only one value allowed.
in queryimageTypestring2XSBy default the response contains images of all image types that are maintained for this product. To receive only images of a specific image view, provide an image view ID. The possible values depend on the Image Management configuration in the ICM.

Only one value allowed.
in queryallImagesstringfalsetrueSpecifies whether images in all image views and image types should be returned.
in queryviewstringtreeUse this parameter to retrieve the whole category hierarchy, not just the top-level.
in querylimitstring2Restrict the number of levels which are included in the response. Use in combination with view.
in queryomitHasOnlineProductsbooleanfalsetrueIf true, the field hasOnlineProducts will not be resolved for subcategories.

Response

200 - OK - The list of categories.

CategoryCollectionRO application/json
{loc}{cur}/categories{spgid}/{categoriesKey}
GET: Returns category info

Description

This operation returns information about a category.

Use the view parameter to retrieve the whole category tree for this category.

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.CategoryRO com.intershop.sellside.rest.common.capi.resource.category.CategoryResource.getCategory(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Boolean)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathcategoriesKeystringComputers/3001/222Required | Either a category path that includes the complete path from the catalog to the current category, or a category reference, as given in the categoryRef field.
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in queryviewstringtreeUse this parameter to retrieve the whole category hierarchy, not just the top-level.
in querylimitstring2Restrict the number of levels which are included in the response. Use in combination with view.
in queryimageViewstringfrontBy default the response contains images of all image views that are maintained for this product. To receive only images of a specific image view, provide an image view ID. The possible values depend on the Image Management configuration in the ICM.

Only one value allowed.
in queryimageTypestring2XSBy default the response contains images of all image types that are maintained for this product. To receive only images of a specific image view, provide an image view ID. The possible values depend on the Image Management configuration in the ICM.

Only one value allowed.
in queryallImagesstringfalsetrueSpecifies whether images in all image views and image types should be returned.
in queryomitHasOnlineProductsbooleanfalsetrueIf true, the field hasOnlineProducts will not be resolved for subcategories.

Response

200 - OK - The category with the given ID.

CategoryRO application/json

404 - Not Found - The category could not be found.

{loc}{cur}/products{spgid}/{productKey}/categories
GET: Returns categories of a product

Description

This operation returns a list of all categories to which the product is explicitly or dynamically assigned.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.ProductResource.getCategories()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in pathproductKeystring4841578Required | The product ID

Response

200 - OK - The categories of the given product.

ResourceCollectionROLinkRO application/json

404 - Not Found - The product could not be found.

Filter API

{loc}{cur}/categories/{categoriesKey}/productfilters
GET: Returns product filters

Description

This operation retrieves a list of product filters for a given category.

Advanced Variation Handling

This resource can be filtered by search index attributes (if specified in the back office).
However, if you filter specifically by MasterSKU, there is a slightly different behavior: When you pass this parameter, you only get filters for variation attributes instead of all filters.

Example: /productfilters?MasterSKU=M123 will exclude filters like price or category to show variation attributes only.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.CategoryProductFiltersResource.getProductFilters(java.lang.String,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathcategoriesKeystringComputers/3001/222Required | The category path that includes the complete path from the catalog to the current category.
in querysearchTermstringAn optional search term
in queryproductFilterstringsort_by_priceA product filter id to be used within categories

Response

200 - OK - The productfilters for the given category.

ResourceCollectionROFilterRO application/json

404 - Not Found - The category could not be found.

{loc}{cur}/productfilters
GET: Returns product filters

Description

This operation retrieves a list of product filters.

Advanced Variation Handling

This resource can be filtered by search index attributes (if specified in the back office).
However, if you filter specifically by MasterSKU, there is a slightly different behavior: When you pass this parameter, you only get filters for variation attributes instead of all filters. The filter values count represents the number of available variations with that filter value.

Example: /productfilters?MasterSKU=M123 will exclude filters like price or category to show variation attributes only.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.ProductFiltersResource.getProductFilters(java.lang.String,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in querysearchTermstringAn optional search term
in queryproductFilterstringsort_by_priceA product filter id to be used for category navigation or search respectively

Response

200 - OK - The list of productfilters.

ResourceCollectionROFilterRO application/json

404 - Not Found

Product API

{loc}{cur}/categories/{categoriesKey}/products/{productKey}/variations/search
POST: Returns variation of a product by search

Description

This operation returns a product variation for a product by searching for product attributes.

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.ProductRO com.intershop.sellside.rest.common.capi.resource.product.VariationResource.searchVariations(javax.ws.rs.core.UriInfo,com.intershop.sellside.rest.common.capi.resourceobject.ProductSearchAttributesRO)

Request Body

ProductSearchAttributesRO application/json

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathcategoriesKeystringComputers/3001/222Required | The category path that includes the complete path from the catalog to the current category.
in pathproductKeystring4841578Required | The product ID

Response

200 - OK - The product variation.

ProductRO application/json

400 - Bad Request - The product is not a product master.

{loc}{cur}/categories/{categoriesKey}/products{spgid}
GET: Returns products by search

Description

This operation returns a list of products for a given search expression. The response contains product stubs which allow to render product lists efficiently.

Advanced Variation Handling

This resource can be filtered by search index attributes (if specified in the back office).
However, if you filter specifically by MasterSKU, there is a slightly different behavior: When you pass this parameter, you will get all variations instead of just the default one.

Example: /products?MasterSKU=M123 will return all variations for the Product Master M123.

Note: If no other sorting is specified, the sorting configured in the back office will be used for product variations.

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.ProductLinkCollectionRO com.intershop.sellside.rest.common.capi.resource.ProductListResource.getProducts(java.lang.String,java.lang.Integer,java.lang.Integer,java.lang.String,java.lang.Boolean,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in pathcategoriesKeystringComputers/3001/222Required | The category path that includes the complete path from the catalog to the current category.
in querypageablestringz_AKDgAFmPAAAAF3hRExUPzeUse for paging through long result lists.

Each response contains a pageable attribute. Use this ID fur subsequent requests (e.g., to get the data for the next page) to ensure consistent data.
in queryoffsetinteger int3202Retrieve one specific set of results from a long list, like a page number.

Use with pageable and amount.
in queryamountinteger int325030Number of items to be returned.
in querysortKeystringname-ascDefine the sorting order of the products. Products can be sorted by name (name-asc or name-desc) or list price (value-asc or value-desc).
in queryreturnSortKeysbooleanfalsefalseSet to true to retrieve the available values for sortKey.
in queryproductFilterstringsort_by_priceThe ID of the search query definition to filter products
in querysearchTermstringAsusSearch Term with wildcards
in queryattrsstringsku,listPrice,manufacturerAllows to retrieve specific data for the product stubs.

Separate multiple values with comma. Available values:

- productName
- sku (product ID)
- shortDescription (minimal item description)
- manufacturer
- image[@<type>] (URL to a product thumbnail image; @ is optional, if not provided type default is M)
- defaultCategory
- listPrice
- salePrice
- productMaster (true, if the product is a variation master)
- productMasterSKU (the sku of the variation master if the current product is a variation product)
- mastered (true, if the product is a variation product)
- averageRating (average user evaluation score)
- roundedAverageRating (rating)
- numberOfRatings
- availability (in stock status, according to the ICM)
- availableStock (the quantity which is available for sale, according to the Inventory Service)
- inStock (in stock status, according to the Inventory Service)
- timeToDelivery (applicable shipping methods estimated delivery time in business days)
- minOrderQuantity
- packingUnit (unit in which the product is sold)
- promotions (applicable promotions)
- retailSet
in queryattributeGroupstringORDER_REQUIRED_ATTRIBUTESUse the ID of an Product Attribute Group to retrieve all its attributes and values. Note that the Group needs to be flagged with "Available via REST" in ICM.

Separate multiple values with comma.
in queryviewstringdefaultdefaultID of a custom view.

It is possible to define alternative views on the product stubs (i.e., which attributes which shall be returned, instead of listing them all individually in the attrs parameter.) This can be done in a WebshopREST.properties file on domain level.

The parameters view and attrs can be combined.

Response

200 - OK - The list of products.

ProductLinkCollectionRO application/json

400 - Bad Request - The query parameters are invalid.

{loc}{cur}/categories/{categoriesKey}/products{spgid}/{productKey}
GET: Returns details of a product

Description

This operation retrieves information of one product, usually in order to render a product details page.

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.ProductRO com.intershop.sellside.rest.common.capi.resource.ProductResource.getProduct(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,boolean)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in pathcategoriesKeystringComputers/3001/222Required | The category path that includes the complete path from the catalog to the current category.
in pathproductKeystring4841578Required | The product ID
in queryattrsstringsku,inStock,manufacturerAllows to retrieve specific data for the product. The parameters view and attrs can be combined.

Separate multiple values with comma.

Available values are every field in the ProductRO class, as well as other attributes that may be set in the product.
in queryviewstringdefaultdefaultID of a custom view.

It is possible to define alternative views on the product stubs (i.e., which attributes which shall be returned, instead of listing them all individually in the attrs parameter.) This can be done in a WebshopREST.properties file on domain level.

The parameters view and attrs can be combined.
in queryimageViewstringfrontBy default the response contains images of all image views that are maintained for this product. To receive only images of a specific image view, provide an image view ID. The possible values depend on the Image Management configuration in the ICM.

Only one value allowed.
in queryimageTypestring2XSBy default the response contains images of all image types that are maintained for this product. To receive only images of a specific image view, provide an image view ID. The possible values depend on the Image Management configuration in the ICM.

Only one value allowed.
in queryallImagesstringfalsetrueSpecify whether the response should contain all or no images.
in querybasketIdstring3CwKDgAFvUgAAAF3PScz6KVyAllows to retrieve prices based on country specific taxes for the specified basket ID.
in queryinvoiceToAddressIdstringQdasEQAFJKAAAAF3o89ZTnFfAllows to retrieve prices based on country specific taxes for the specified address ID.
in queryshipToAddressIdstringQdasEQAFJKAAAAF3o89ZTnFfAllows to retrieve prices based on country specific taxes for the specified shipping address ID.
in queryshipFromAddressIdstringSX6sEQAFMaYAAAF33DhZTnFfAllows to retrieve prices based on country specific taxes for the specified sender address ID.
in queryextendedbooleanfalsefalseSet to true to fetch extended information on product variations.

Response

200 - OK - The product with the given ID.

ProductRO application/json

404 - Not Found - The product could not be found.

{loc}{cur}/categories/{categoriesKey}/products{spgid}/{productKey}/bundles
GET: Returns bundled products

Description

This operation returns list of all bundled products for a bundle.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.ProductResource.getBundledProducts(java.lang.String,java.lang.Integer,java.lang.Integer)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in pathcategoriesKeystringComputers/3001/222Required | The category path that includes the complete path from the catalog to the current category.
in pathproductKeystring4841578Required | The product ID
in querypageablestringz_AKDgAFmPAAAAF3hRExUPzeUse for paging through long result lists.

Each response contains a pageable attribute. Use this ID fur subsequent requests (e.g., to get the data for the next page) to ensure consistent data.
in queryoffsetinteger int3202Retrieve one specific set of results from a long list, like a page number.

Use with pageable and amount.
in queryamountinteger int325030Number of items to be returned.

Response

200 - OK - The bundled products.

ResourceCollectionROLinkRO application/json

404 - Not Found - The product could not be found.

{loc}{cur}/categories/{categoriesKey}/products{spgid}/{productKey}/categories
GET: Returns categories of a product

Description

This operation returns a list of all categories to which the product is explicitly or dynamically assigned.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.ProductResource.getCategories()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in pathcategoriesKeystringComputers/3001/222Required | The category path that includes the complete path from the catalog to the current category.
in pathproductKeystring4841578Required | The product ID

Response

200 - OK - The categories of the given product.

ResourceCollectionROLinkRO application/json

404 - Not Found - The product could not be found.

{loc}{cur}/categories/{categoriesKey}/products{spgid}/{productKey}/crosssells
GET: Returns product cross sells

Description

This operation returns a list of cross sells of a product.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.ProductResource.getProductCrossSells()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in pathcategoriesKeystringComputers/3001/222Required | The category path that includes the complete path from the catalog to the current category.
in pathproductKeystring4841578Required | The product ID

Response

200 - OK - The cross sells of the given product.

ResourceCollectionROLinkRO application/json

404 - Not Found - The product could not be found.

{loc}{cur}/categories/{categoriesKey}/products{spgid}/{productKey}/links
GET: Returns product links of a product

Description

This operation returns all product links of a product. The links are grouped by type and contains both linked products and categories.

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.TypedLinkRO$TypedLinksCollectionRO com.intershop.sellside.rest.common.capi.resource.ProductLinksResource.getProductLinks(java.lang.String,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in pathcategoriesKeystringComputers/3001/222Required | The category path that includes the complete path from the catalog to the current category.
in pathproductKeystring4841578Required | The product ID
in querylinkTypestringaccessoryThe type of links to retrieve
in querytargetObjectstringproductThe target of the links to fetch

Response

200 - OK - The links for the given product.

TypedLinksCollectionRO application/json

400 - Bad Request - The query parameters are invalid.

404 - Not Found - The product could not be found.

{loc}{cur}/categories/{categoriesKey}/products{spgid}/{productKey}/partOfRetailSet
GET: Returns products of retail set

Description

This operation returns a list of all products assigned to a retail set.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.ProductResource.getPartOfRetailSet(java.lang.String,java.lang.Integer,java.lang.Integer)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in pathcategoriesKeystringComputers/3001/222Required | The category path that includes the complete path from the catalog to the current category.
in pathproductKeystring4841578Required | The product ID
in querypageablestringz_AKDgAFmPAAAAF3hRExUPzeUse for paging through long result lists.

Each response contains a pageable attribute. Use this ID fur subsequent requests (e.g., to get the data for the next page) to ensure consistent data.
in queryoffsetinteger int3202Retrieve one specific set of results from a long list, like a page number.

Use with pageable and amount.
in queryamountinteger int325030Number of items to be returned.

Response

200 - OK - The products assigned to the retail set.

ResourceCollectionROLinkRO application/json

404 - Not Found - The product could not be found.

{loc}{cur}/categories/{categoriesKey}/products{spgid}/{productKey}/variations
GET: Returns variations of a product

Description

This operation returns a list of all variation products for a variation master.

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.VariationAttributeRO$VariationCollectionRO com.intershop.sellside.rest.common.capi.resource.product.VariationResource.getVariations(java.lang.String,java.lang.Integer,java.lang.Integer,boolean)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in pathcategoriesKeystringComputers/3001/222Required | The category path that includes the complete path from the catalog to the current category.
in pathproductKeystring4841578Required | The product ID
in querypageablestringz_AKDgAFmPAAAAF3hRExUPzeUse for paging through long result lists.

Each response contains a pageable attribute. Use this ID fur subsequent requests (e.g., to get the data for the next page) to ensure consistent data.
in queryoffsetinteger int3202Retrieve one specific set of results from a long list, like a page number.

Use with pageable and amount.
in queryamountinteger int325030Number of items to be returned.
in queryextendedbooleanfalsefalseSet to true to fetch extended information on product variations

Response

200 - OK - The variations of the given product.

VariationCollectionRO application/json

404 - Not Found

{loc}{cur}/products/{productKey}/variations/search
POST: Returns variation of a product by search

Description

This operation returns a product variation for a product by searching for product attributes.

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.ProductRO com.intershop.sellside.rest.common.capi.resource.product.VariationResource.searchVariations(javax.ws.rs.core.UriInfo,com.intershop.sellside.rest.common.capi.resourceobject.ProductSearchAttributesRO)

Request Body

ProductSearchAttributesRO application/json

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathproductKeystring4841578Required | The product ID

Response

200 - OK - The product variation.

ProductRO application/json

400 - Bad Request - The product is not a product master.

{loc}{cur}/products{spgid}
GET: Returns products by search

Description

This operation returns a list of products for a given search expression. The response contains product stubs which allow to render product lists efficiently.

Advanced Variation Handling

This resource can be filtered by search index attributes (if specified in the back office).
However, if you filter specifically by MasterSKU, there is a slightly different behavior: When you pass this parameter, you will get all variations instead of just the default one.

Example: /products?MasterSKU=M123 will return all variations for the Product Master M123.

Note: If no other sorting is specified, the sorting configured in the back office will be used for product variations.

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.ProductLinkCollectionRO com.intershop.sellside.rest.common.capi.resource.ProductListResource.getProducts(java.lang.String,java.lang.Integer,java.lang.Integer,java.lang.String,java.lang.Boolean,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in querypageablestringz_AKDgAFmPAAAAF3hRExUPzeUse for paging through long result lists.

Each response contains a pageable attribute. Use this ID fur subsequent requests (e.g., to get the data for the next page) to ensure consistent data.
in queryoffsetinteger int3202Retrieve one specific set of results from a long list, like a page number.

Use with pageable and amount.
in queryamountinteger int325030Number of items to be returned.
in querysortKeystringname-ascDefine the sorting order of the products. Products can be sorted by name (name-asc or name-desc) or list price (value-asc or value-desc).
in queryreturnSortKeysbooleanfalsefalseSet to true to retrieve the available values for sortKey.
in queryproductFilterstringsort_by_priceThe ID of the search query definition to filter products
in querysearchTermstringAsusSearch Term with wildcards
in queryattrsstringsku,listPrice,manufacturerAllows to retrieve specific data for the product stubs.

Separate multiple values with comma. Available values:

- productName
- sku (product ID)
- shortDescription (minimal item description)
- manufacturer
- image[@<type>] (URL to a product thumbnail image; @ is optional, if not provided type default is M)
- defaultCategory
- listPrice
- salePrice
- productMaster (true, if the product is a variation master)
- productMasterSKU (the sku of the variation master if the current product is a variation product)
- mastered (true, if the product is a variation product)
- averageRating (average user evaluation score)
- roundedAverageRating (rating)
- numberOfRatings
- availability (in stock status, according to the ICM)
- availableStock (the quantity which is available for sale, according to the Inventory Service)
- inStock (in stock status, according to the Inventory Service)
- timeToDelivery (applicable shipping methods estimated delivery time in business days)
- minOrderQuantity
- packingUnit (unit in which the product is sold)
- promotions (applicable promotions)
- retailSet
in queryattributeGroupstringORDER_REQUIRED_ATTRIBUTESUse the ID of an Product Attribute Group to retrieve all its attributes and values. Note that the Group needs to be flagged with "Available via REST" in ICM.

Separate multiple values with comma.
in queryviewstringdefaultdefaultID of a custom view.

It is possible to define alternative views on the product stubs (i.e., which attributes which shall be returned, instead of listing them all individually in the attrs parameter.) This can be done in a WebshopREST.properties file on domain level.

The parameters view and attrs can be combined.

Response

200 - OK - The list of products.

ProductLinkCollectionRO application/json

400 - Bad Request - The query parameters are invalid.

{loc}{cur}/products{spgid}/{productKey}
GET: Returns details of a product

Description

This operation retrieves information of one product, usually in order to render a product details page.

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.ProductRO com.intershop.sellside.rest.common.capi.resource.ProductResource.getProduct(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,boolean)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in pathproductKeystring4841578Required | The product ID
in queryattrsstringsku,inStock,manufacturerAllows to retrieve specific data for the product. The parameters view and attrs can be combined.

Separate multiple values with comma.

Available values are every field in the ProductRO class, as well as other attributes that may be set in the product.
in queryviewstringdefaultdefaultID of a custom view.

It is possible to define alternative views on the product stubs (i.e., which attributes which shall be returned, instead of listing them all individually in the attrs parameter.) This can be done in a WebshopREST.properties file on domain level.

The parameters view and attrs can be combined.
in queryimageViewstringfrontBy default the response contains images of all image views that are maintained for this product. To receive only images of a specific image view, provide an image view ID. The possible values depend on the Image Management configuration in the ICM.

Only one value allowed.
in queryimageTypestring2XSBy default the response contains images of all image types that are maintained for this product. To receive only images of a specific image view, provide an image view ID. The possible values depend on the Image Management configuration in the ICM.

Only one value allowed.
in queryallImagesstringfalsetrueSpecify whether the response should contain all or no images.
in querybasketIdstring3CwKDgAFvUgAAAF3PScz6KVyAllows to retrieve prices based on country specific taxes for the specified basket ID.
in queryinvoiceToAddressIdstringQdasEQAFJKAAAAF3o89ZTnFfAllows to retrieve prices based on country specific taxes for the specified address ID.
in queryshipToAddressIdstringQdasEQAFJKAAAAF3o89ZTnFfAllows to retrieve prices based on country specific taxes for the specified shipping address ID.
in queryshipFromAddressIdstringSX6sEQAFMaYAAAF33DhZTnFfAllows to retrieve prices based on country specific taxes for the specified sender address ID.
in queryextendedbooleanfalsefalseSet to true to fetch extended information on product variations.

Response

200 - OK - The product with the given ID.

ProductRO application/json

404 - Not Found - The product could not be found.

{loc}{cur}/products{spgid}/{productKey}/bundles
GET: Returns bundled products

Description

This operation returns list of all bundled products for a bundle.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.ProductResource.getBundledProducts(java.lang.String,java.lang.Integer,java.lang.Integer)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in pathproductKeystring4841578Required | The product ID
in querypageablestringz_AKDgAFmPAAAAF3hRExUPzeUse for paging through long result lists.

Each response contains a pageable attribute. Use this ID fur subsequent requests (e.g., to get the data for the next page) to ensure consistent data.
in queryoffsetinteger int3202Retrieve one specific set of results from a long list, like a page number.

Use with pageable and amount.
in queryamountinteger int325030Number of items to be returned.

Response

200 - OK - The bundled products.

ResourceCollectionROLinkRO application/json

404 - Not Found - The product could not be found.

{loc}{cur}/products{spgid}/{productKey}/categories
GET: Returns categories of a product

Description

This operation returns a list of all categories to which the product is explicitly or dynamically assigned.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.ProductResource.getCategories()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in pathproductKeystring4841578Required | The product ID

Response

200 - OK - The categories of the given product.

ResourceCollectionROLinkRO application/json

404 - Not Found - The product could not be found.

{loc}{cur}/products{spgid}/{productKey}/crosssells
GET: Returns product cross sells

Description

This operation returns a list of cross sells of a product.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.ProductResource.getProductCrossSells()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in pathproductKeystring4841578Required | The product ID

Response

200 - OK - The cross sells of the given product.

ResourceCollectionROLinkRO application/json

404 - Not Found - The product could not be found.

{loc}{cur}/products{spgid}/{productKey}/links
GET: Returns product links of a product

Description

This operation returns all product links of a product. The links are grouped by type and contains both linked products and categories.

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.TypedLinkRO$TypedLinksCollectionRO com.intershop.sellside.rest.common.capi.resource.ProductLinksResource.getProductLinks(java.lang.String,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in pathproductKeystring4841578Required | The product ID
in querylinkTypestringaccessoryThe type of links to retrieve
in querytargetObjectstringproductThe target of the links to fetch

Response

200 - OK - The links for the given product.

TypedLinksCollectionRO application/json

400 - Bad Request - The query parameters are invalid.

404 - Not Found - The product could not be found.

{loc}{cur}/products{spgid}/{productKey}/partOfRetailSet
GET: Returns products of retail set

Description

This operation returns a list of all products assigned to a retail set.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.ProductResource.getPartOfRetailSet(java.lang.String,java.lang.Integer,java.lang.Integer)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in pathproductKeystring4841578Required | The product ID
in querypageablestringz_AKDgAFmPAAAAF3hRExUPzeUse for paging through long result lists.

Each response contains a pageable attribute. Use this ID fur subsequent requests (e.g., to get the data for the next page) to ensure consistent data.
in queryoffsetinteger int3202Retrieve one specific set of results from a long list, like a page number.

Use with pageable and amount.
in queryamountinteger int325030Number of items to be returned.

Response

200 - OK - The products assigned to the retail set.

ResourceCollectionROLinkRO application/json

404 - Not Found - The product could not be found.

{loc}{cur}/products{spgid}/{productKey}/variations
GET: Returns variations of a product

Description

This operation returns a list of all variation products for a variation master.

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.VariationAttributeRO$VariationCollectionRO com.intershop.sellside.rest.common.capi.resource.product.VariationResource.getVariations(java.lang.String,java.lang.Integer,java.lang.Integer,boolean)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the site's or user's default locale is used.
in pathcurstringUSDThe currency code (submitted as optional matrix parameter ;cur=<CURRENCY>). If omitted, the site's or user's default currency is used.
in pathspgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID>
in pathproductKeystring4841578Required | The product ID
in querypageablestringz_AKDgAFmPAAAAF3hRExUPzeUse for paging through long result lists.

Each response contains a pageable attribute. Use this ID fur subsequent requests (e.g., to get the data for the next page) to ensure consistent data.
in queryoffsetinteger int3202Retrieve one specific set of results from a long list, like a page number.

Use with pageable and amount.
in queryamountinteger int325030Number of items to be returned.
in queryextendedbooleanfalsefalseSet to true to fetch extended information on product variations

Response

200 - OK - The variations of the given product.

VariationCollectionRO application/json

404 - Not Found

Request and Response Object Schemata

CategoryCollectionRO application/json{
  • "pageable":
    string
    The pageable ID
  • "total":
    integer
    The pageable amount total | Format: int32
  • "offset":
    integer
    The pageable offset | Format: int32
  • "amount":
    integer
    The pageable amount | Format: int32
  • "elements":
    array
    An array of CategoryRO objects. The list of elements
    [
    CategoryRO
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: Category
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "hasOnlineProducts":
      boolean
      indicates if this (sub)-category has online products
    • "hasOnlineSubCategories":
      boolean
      indicates if this (sub)-category has online sub categories
    • "onlineProductsCountInSubCategories":
      integer
      Format: int32
    • "products":
      string
      the products in this (sub)-category
    • "online":
      string
      the online of this (sub)-category | Example: 1
    • "description":
      string
      the description of this (sub)-category | Example: The Vectra products and services catalog.
    • "richContent":
      string
      The content for the category page, maintained in the 'Content' field at the category in Intershop Commerce Management.
    • "subCategoriesCount":
      integer
      the count of sub categories | Format: int32 | Example: 1
    • "image":
      object
      A LinkRO object. A Link pointing to a resource
      {
      • "name":
        string
        the name of the returned element
      • "type":
        string
        Readonly | This is a constant: Link | Example: Link
      • "attributes":
        array
        An array of ResourceAttribute objects. the list of attributes
        [
        ResourceAttribute: An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
        ]
      • "uri":
        string
        The uri
      • "relation":
        string
        The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
      • "title":
        string
        The title of the link
      • "description":
        string
        The description of the link
      • "itemId":
        string
        the Id of the linked item
      • "attribute":
        object
        A ResourceAttribute object. An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
      }
    • "images":
      array
      An array of ImageRO objects. the images of this (sub)-category
      [
      ImageRO
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: Image
      • "attributes":
        array
        An array of ResourceAttribute objects. the list of attributes
        [
        ResourceAttribute: An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
        ]
      • "effectiveUrl":
        string
        the effective URL of the image | Example: /INTERSHOP/static/WFS/PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/PrimeTech/en_US/1XL/350617-1238.jpg
      • "viewID":
        string
        the view id of the image | Example: front
      • "typeID":
        string
        the type id of the image | Example: 1XL
      • "actualHeight":
        integer
        Format: int32
      • "actualWidth":
        integer
        Format: int32
      • "imageActualHeight":
        integer
        the actual height of the image | Format: int32 | Example: 220
      • "imageActualWidth":
        integer
        the actual width of the image | Format: int32 | Example: 220
      • "primaryImage":
        boolean
        indicates if this image is the primary image
      • "attribute":
        object
        A ResourceAttribute object. An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
      }
      ]
    • "categoryPath":
      array
      An array of CategoryPathRO objects.
      [
      CategoryPathRO
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
      • "attributes":
        array
        An array of ResourceAttribute objects. the list of attributes
        [
        ResourceAttribute: An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
        ]
      • "id":
        string
      • "uri":
        string
      • "attribute":
        object
        A ResourceAttribute object. An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
      }
      ]
    • "thumbnail":
      object
      A LinkRO object. A Link pointing to a resource
      {
      • "name":
        string
        the name of the returned element
      • "type":
        string
        Readonly | This is a constant: Link | Example: Link
      • "attributes":
        array
        An array of ResourceAttribute objects. the list of attributes
        [
        ResourceAttribute: An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
        ]
      • "uri":
        string
        The uri
      • "relation":
        string
        The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
      • "title":
        string
        The title of the link
      • "description":
        string
        The description of the link
      • "itemId":
        string
        the Id of the linked item
      • "attribute":
        object
        A ResourceAttribute object. An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
      }
    • "id":
      string
      the id of this (sub)-category | Example: Cameras-Camcorders
    • "categoryRef":
      string
      the categoryRef of this (sub)-category | Example: 832@inSPIRED-inTRONICS-Cameras-Camcorders
    • "subCategories":
      array
      An array of AbstractResourceObject objects. List of subcategories of this (sub)-category
      [
      AbstractResourceObject: the list of elements
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
      }
      ]
    • "uri":
      string
      the uri of this (sub)-category | Example: PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/1290
    • "productList":
      array
      An array of LinkRO objects. List of products in this (sub)-category as List of LinkROs
      [
      LinkRO: A Link pointing to a resource
      {
      • "name":
        string
        the name of the returned element
      • "type":
        string
        Readonly | This is a constant: Link | Example: Link
      • "attributes":
        array
        An array of ResourceAttribute objects. the list of attributes
        [
        ResourceAttribute: An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
        ]
      • "uri":
        string
        The uri
      • "relation":
        string
        The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
      • "title":
        string
        The title of the link
      • "description":
        string
        The description of the link
      • "itemId":
        string
        the Id of the linked item
      • "attribute":
        object
        A ResourceAttribute object. An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
      }
      ]
    • "seoAttributes":
      object
      A SEOMetaAttributes object.
      {
      • "metaTitle":
        string
      • "metaDescription":
        string
      • "robots":
        array
        An array of string literals.
      }
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "name":
    string
    The name of an element.
}
CategoryRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: Category
  • "attributes":
    array
    An array of ResourceAttribute objects. the list of attributes
    [
    ResourceAttribute: An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
    ]
  • "hasOnlineProducts":
    boolean
    indicates if this (sub)-category has online products
  • "hasOnlineSubCategories":
    boolean
    indicates if this (sub)-category has online sub categories
  • "onlineProductsCountInSubCategories":
    integer
    Format: int32
  • "products":
    string
    the products in this (sub)-category
  • "online":
    string
    the online of this (sub)-category | Example: 1
  • "description":
    string
    the description of this (sub)-category | Example: The Vectra products and services catalog.
  • "richContent":
    string
    The content for the category page, maintained in the 'Content' field at the category in Intershop Commerce Management.
  • "subCategoriesCount":
    integer
    the count of sub categories | Format: int32 | Example: 1
  • "image":
    object
    A LinkRO object. A Link pointing to a resource
    {
    • "name":
      string
      the name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The uri
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      the Id of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
  • "images":
    array
    An array of ImageRO objects. the images of this (sub)-category
    [
    ImageRO
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: Image
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "effectiveUrl":
      string
      the effective URL of the image | Example: /INTERSHOP/static/WFS/PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/PrimeTech/en_US/1XL/350617-1238.jpg
    • "viewID":
      string
      the view id of the image | Example: front
    • "typeID":
      string
      the type id of the image | Example: 1XL
    • "actualHeight":
      integer
      Format: int32
    • "actualWidth":
      integer
      Format: int32
    • "imageActualHeight":
      integer
      the actual height of the image | Format: int32 | Example: 220
    • "imageActualWidth":
      integer
      the actual width of the image | Format: int32 | Example: 220
    • "primaryImage":
      boolean
      indicates if this image is the primary image
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "categoryPath":
    array
    An array of CategoryPathRO objects.
    [
    CategoryPathRO
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "id":
      string
    • "uri":
      string
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "thumbnail":
    object
    A LinkRO object. A Link pointing to a resource
    {
    • "name":
      string
      the name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The uri
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      the Id of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
  • "id":
    string
    the id of this (sub)-category | Example: Cameras-Camcorders
  • "categoryRef":
    string
    the categoryRef of this (sub)-category | Example: 832@inSPIRED-inTRONICS-Cameras-Camcorders
  • "subCategories":
    array
    An array of AbstractResourceObject objects. List of subcategories of this (sub)-category
    [
    AbstractResourceObject: the list of elements
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    }
    ]
  • "uri":
    string
    the uri of this (sub)-category | Example: PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/1290
  • "productList":
    array
    An array of LinkRO objects. List of products in this (sub)-category as List of LinkROs
    [
    LinkRO: A Link pointing to a resource
    {
    • "name":
      string
      the name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The uri
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      the Id of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "seoAttributes":
    object
    A SEOMetaAttributes object.
    {
    • "metaTitle":
      string
    • "metaDescription":
      string
    • "robots":
      array
      An array of string literals.
    }
  • "attribute":
    object
    A ResourceAttribute object. An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
}
ProductLinkCollectionRO application/json{
  • "pageable":
    string
    The pageable ID
  • "total":
    integer
    The pageable amount total | Format: int32
  • "offset":
    integer
    The pageable offset | Format: int32
  • "amount":
    integer
    The pageable amount | Format: int32
  • "elements":
    array
    An array of LinkRO objects. The list of elements
    [
    LinkRO: A Link pointing to a resource
    {
    • "name":
      string
      the name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The uri
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      the Id of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "sortableAttributes":
    object
    The sortable attributes for this search result.
  • "name":
    string
    The name of an element.
}
ProductRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "attributes":
    array
    An array of ResourceAttribute objects. the list of attributes
    [
    ResourceAttribute: An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
    ]
  • "sku":
    string
  • "productName":
    string
  • "shortDescription":
    string
  • "longDescription":
    string
  • "productTypes":
    array
    An array of string literals.
  • "availability":
    boolean
  • "retailSet":
    boolean
  • "inStock":
    boolean
  • "availableStock":
    number
  • "productMaster":
    boolean
  • "productMasterSKU":
    string
  • "mastered":
    boolean
  • "roundedAverageRating":
    string
  • "averageRating":
    string
  • "readyForShipmentMin":
    integer
    Format: int32
  • "readyForShipmentMax":
    integer
    Format: int32
  • "minOrderQuantity":
    number
  • "productBundle":
    boolean
  • "manufacturer":
    string
  • "listPrice":
    object
    A ProductPriceRO object.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "locale":
      object
      {
      • "language":
        string
      • "script":
        string
      • "country":
        string
      • "variant":
        string
      • "extensionKeys":
        array
        An array of string literals.
      • "unicodeLocaleAttributes":
        array
        An array of string literals.
      • "unicodeLocaleKeys":
        array
        An array of string literals.
      • "iso3Language":
        string
      • "iso3Country":
        string
      • "displayLanguage":
        string
      • "displayScript":
        string
      • "displayCountry":
        string
      • "displayVariant":
        string
      • "displayName":
        string
      }
    • "value":
      number
    • "currencyMnemonic":
      string
    • "priceText":
      string
    • "currency":
      string
    }
  • "salePrice":
    object
    A ProductPriceRO object.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "locale":
      object
      {
      • "language":
        string
      • "script":
        string
      • "country":
        string
      • "variant":
        string
      • "extensionKeys":
        array
        An array of string literals.
      • "unicodeLocaleAttributes":
        array
        An array of string literals.
      • "unicodeLocaleKeys":
        array
        An array of string literals.
      • "iso3Language":
        string
      • "iso3Country":
        string
      • "displayLanguage":
        string
      • "displayScript":
        string
      • "displayCountry":
        string
      • "displayVariant":
        string
      • "displayName":
        string
      }
    • "value":
      number
    • "currencyMnemonic":
      string
    • "priceText":
      string
    • "currency":
      string
    }
  • "minListPrice":
    object
    A ProductPriceRO object.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "locale":
      object
      {
      • "language":
        string
      • "script":
        string
      • "country":
        string
      • "variant":
        string
      • "extensionKeys":
        array
        An array of string literals.
      • "unicodeLocaleAttributes":
        array
        An array of string literals.
      • "unicodeLocaleKeys":
        array
        An array of string literals.
      • "iso3Language":
        string
      • "iso3Country":
        string
      • "displayLanguage":
        string
      • "displayScript":
        string
      • "displayCountry":
        string
      • "displayVariant":
        string
      • "displayName":
        string
      }
    • "value":
      number
    • "currencyMnemonic":
      string
    • "priceText":
      string
    • "currency":
      string
    }
  • "maxListPrice":
    object
    A ProductPriceRO object.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "locale":
      object
      {
      • "language":
        string
      • "script":
        string
      • "country":
        string
      • "variant":
        string
      • "extensionKeys":
        array
        An array of string literals.
      • "unicodeLocaleAttributes":
        array
        An array of string literals.
      • "unicodeLocaleKeys":
        array
        An array of string literals.
      • "iso3Language":
        string
      • "iso3Country":
        string
      • "displayLanguage":
        string
      • "displayScript":
        string
      • "displayCountry":
        string
      • "displayVariant":
        string
      • "displayName":
        string
      }
    • "value":
      number
    • "currencyMnemonic":
      string
    • "priceText":
      string
    • "currency":
      string
    }
  • "minSalePrice":
    object
    A ProductPriceRO object.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "locale":
      object
      {
      • "language":
        string
      • "script":
        string
      • "country":
        string
      • "variant":
        string
      • "extensionKeys":
        array
        An array of string literals.
      • "unicodeLocaleAttributes":
        array
        An array of string literals.
      • "unicodeLocaleKeys":
        array
        An array of string literals.
      • "iso3Language":
        string
      • "iso3Country":
        string
      • "displayLanguage":
        string
      • "displayScript":
        string
      • "displayCountry":
        string
      • "displayVariant":
        string
      • "displayName":
        string
      }
    • "value":
      number
    • "currencyMnemonic":
      string
    • "priceText":
      string
    • "currency":
      string
    }
  • "maxSalePrice":
    object
    A ProductPriceRO object.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "locale":
      object
      {
      • "language":
        string
      • "script":
        string
      • "country":
        string
      • "variant":
        string
      • "extensionKeys":
        array
        An array of string literals.
      • "unicodeLocaleAttributes":
        array
        An array of string literals.
      • "unicodeLocaleKeys":
        array
        An array of string literals.
      • "iso3Language":
        string
      • "iso3Country":
        string
      • "displayLanguage":
        string
      • "displayScript":
        string
      • "displayCountry":
        string
      • "displayVariant":
        string
      • "displayName":
        string
      }
    • "value":
      number
    • "currencyMnemonic":
      string
    • "priceText":
      string
    • "currency":
      string
    }
  • "summedUpListPrice":
    object
    A ProductPriceRO object.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "locale":
      object
      {
      • "language":
        string
      • "script":
        string
      • "country":
        string
      • "variant":
        string
      • "extensionKeys":
        array
        An array of string literals.
      • "unicodeLocaleAttributes":
        array
        An array of string literals.
      • "unicodeLocaleKeys":
        array
        An array of string literals.
      • "iso3Language":
        string
      • "iso3Country":
        string
      • "displayLanguage":
        string
      • "displayScript":
        string
      • "displayCountry":
        string
      • "displayVariant":
        string
      • "displayName":
        string
      }
    • "value":
      number
    • "currencyMnemonic":
      string
    • "priceText":
      string
    • "currency":
      string
    }
  • "summedUpSalePrice":
    object
    A ProductPriceRO object.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "locale":
      object
      {
      • "language":
        string
      • "script":
        string
      • "country":
        string
      • "variant":
        string
      • "extensionKeys":
        array
        An array of string literals.
      • "unicodeLocaleAttributes":
        array
        An array of string literals.
      • "unicodeLocaleKeys":
        array
        An array of string literals.
      • "iso3Language":
        string
      • "iso3Country":
        string
      • "displayLanguage":
        string
      • "displayScript":
        string
      • "displayCountry":
        string
      • "displayVariant":
        string
      • "displayName":
        string
      }
    • "value":
      number
    • "currencyMnemonic":
      string
    • "priceText":
      string
    • "currency":
      string
    }
  • "endOfLife":
    integer
    Format: int64
  • "lastOrderDate":
    integer
    Format: int64
  • "maxOrderQuantity":
    number
  • "stepOrderQuantity":
    number
  • "packingUnit":
    string
  • "price":
    string
  • "currencyCode":
    string
  • "variations":
    string
  • "crosssells":
    string
  • "bundles":
    string
  • "partOfRetailSet":
    string
  • "reviews":
    string
  • "shippingMethods":
    array
    An array of ShippingMethodRO objects.
    [
    ShippingMethodRO: This resource describes a shipping method that can be selected as delivery option.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: ShippingMethod
    • "id":
      string
      the id of the returned element | Example: STD_GROUND
    • "shippingTimeMin":
      integer
      The minimum shipping time in days | Format: int32 | Example: 3
    • "shippingTimeMax":
      integer
      The maximum shipping time in days | Format: int32 | Example: 7
    }
    ]
  • "availableWarranties":
    array
    An array of LinkRO objects.
    [
    LinkRO: A Link pointing to a resource
    {
    • "name":
      string
      the name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The uri
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      the Id of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "availableGiftWraps":
    array
    An array of LinkRO objects.
    [
    LinkRO: A Link pointing to a resource
    {
    • "name":
      string
      the name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The uri
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      the Id of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "availableGiftMessages":
    array
    An array of LinkRO objects.
    [
    LinkRO: A Link pointing to a resource
    {
    • "name":
      string
      the name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The uri
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      the Id of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "images":
    array
    An array of ImageRO objects.
    [
    ImageRO
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: Image
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "effectiveUrl":
      string
      the effective URL of the image | Example: /INTERSHOP/static/WFS/PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/PrimeTech/en_US/1XL/350617-1238.jpg
    • "viewID":
      string
      the view id of the image | Example: front
    • "typeID":
      string
      the type id of the image | Example: 1XL
    • "actualHeight":
      integer
      Format: int32
    • "actualWidth":
      integer
      Format: int32
    • "imageActualHeight":
      integer
      the actual height of the image | Format: int32 | Example: 220
    • "imageActualWidth":
      integer
      the actual width of the image | Format: int32 | Example: 220
    • "primaryImage":
      boolean
      indicates if this image is the primary image
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "defaultCategory":
    object
    A DefaultCategoryRO object.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "id":
      string
    • "categoryPath":
      array
      An array of CategoryPathRO objects.
      [
      CategoryPathRO
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
      • "attributes":
        array
        An array of ResourceAttribute objects. the list of attributes
        [
        ResourceAttribute: An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
        ]
      • "id":
        string
      • "uri":
        string
      • "attribute":
        object
        A ResourceAttribute object. An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
      }
      ]
    • "uri":
      string
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
  • "attributeGroups":
    object
  • "attachments":
    array
    An array of AttachmentRO objects.
    [
    AttachmentRO
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "key":
      string
    • "value":
      string
    • "description":
      string
    • "uri":
      boolean
    • "link":
      object
      A LinkRO object. A Link pointing to a resource
      {
      • "name":
        string
        the name of the returned element
      • "type":
        string
        Readonly | This is a constant: Link | Example: Link
      • "attributes":
        array
        An array of ResourceAttribute objects. the list of attributes
        [
        ResourceAttribute: An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
        ]
      • "uri":
        string
        The uri
      • "relation":
        string
        The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
      • "title":
        string
        The title of the link
      • "description":
        string
        The description of the link
      • "itemId":
        string
        the Id of the linked item
      • "attribute":
        object
        A ResourceAttribute object. An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
      }
    }
    ]
  • "additionalAttributes":
    array
    An array of ResourceAttribute objects.
    [
    ResourceAttribute: An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
    ]
  • "variationAttributeValues":
    array
    An array of VariationAttributeRO objects.
    [
    VariationAttributeRO
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "value":
      string
    • "variationAttributeId":
      string
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "variationAttributeValuesExtended":
    array
    An array of VariationAttributeExtendedRO objects.
    [
    VariationAttributeExtendedRO
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "variationAttributeId":
      string
    • "value":
      object
      A AttachmentAttributeROObject object.
      {
      • "type":
        string
        The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
      • "name":
        string
        The name of an element.
      • "value":
        object
      }
    • "values":
      array
      An array of VariationAttributeValueRO objects.
      [
      VariationAttributeValueRO
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
      • "attributes":
        array
        An array of ResourceAttribute objects. the list of attributes
        [
        ResourceAttribute: An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
        ]
      • "value":
        object
        A AttachmentAttributeROObject object.
        {
        • "type":
          string
          The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
        • "name":
          string
          The name of an element.
        • "value":
          object
        }
      • "metadata":
        object
        A MetadataRO object.
        {
        • "name":
          string
          The name of an element.
        • "type":
          string
          Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
        • "attributes":
          array
          An array of ResourceAttribute objects. the list of attributes
          [
          ResourceAttribute: An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
          ]
        • "colorCode":
          string
        • "imagePath":
          string
        • "attribute":
          object
          A ResourceAttribute object. An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
        }
      • "attribute":
        object
        A ResourceAttribute object. An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
      }
      ]
    • "attributeType":
      string
    • "metadata":
      object
      A MetadataRO object.
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
      • "attributes":
        array
        An array of ResourceAttribute objects. the list of attributes
        [
        ResourceAttribute: An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
        ]
      • "colorCode":
        string
      • "imagePath":
        string
      • "attribute":
        object
        A ResourceAttribute object. An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
      }
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "variableVariationAttributes":
    array
    An array of VariationAttributeRO objects.
    [
    VariationAttributeRO
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "value":
      string
    • "variationAttributeId":
      string
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "timeToDelivery":
    array
    An array of ProductShippingMethodDeliveryRO objects.
    [
    ProductShippingMethodDeliveryRO
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "timeToDeliveryMin":
      integer
      Format: int32
    • "timeToDeliveryMax":
      integer
      Format: int32
    • "shippingMethodId":
      string
    • "shippingMethodName":
      string
    }
    ]
  • "promotions":
    array
    An array of LinkRO objects.
    [
    LinkRO: A Link pointing to a resource
    {
    • "name":
      string
      the name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The uri
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      the Id of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "seoAttributes":
    object
    A SEOMetaAttributes object.
    {
    • "metaTitle":
      string
    • "metaDescription":
      string
    • "robots":
      array
      An array of string literals.
    }
  • "numberOfReviews":
    integer
    Format: int32
  • "supplierSKU":
    string
  • "attribute":
    object
    A ResourceAttribute object. An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
}
ProductSearchAttributesRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "attributes":
    array
    An array of ResourceAttribute objects. the list of attributes
    [
    ResourceAttribute: An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
    ]
  • "masterProductSKU":
    string
  • "prioritySearchAttribute":
    string
  • "searchAttributes":
    object
  • "attribute":
    object
    A ResourceAttribute object. An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
}
ResourceCollectionROFilterRO application/json{
  • "pageable":
    string
    The pageable ID
  • "total":
    integer
    The pageable amount total | Format: int32
  • "offset":
    integer
    The pageable offset | Format: int32
  • "amount":
    integer
    The pageable amount | Format: int32
  • "elements":
    array
    An array of FilterRO objects. The list of elements
    [
    FilterRO: Represents a filter
    {
    • "name":
      string
      The name of an element. | Example: Taxonomic Filter
    • "type":
      string
      The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: Filter
    • "id":
      string
      ID of filter | Example: CategoryUUIDLevelMulti
    • "filterEntries":
      array
      An array of FilterEntryRO objects. Filter Entries | Example: Object of type FilterEntryRO
      [
      FilterEntryRO: Filter Entries
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
      • "count":
        integer
        Format: int32
      • "value":
        string
      • "mappedType":
        string
      • "mappedValue":
        string
      • "level":
        integer
        Format: int32
      • "searchParameter":
        string
      • "displayValue":
        string
      • "link":
        object
        A LinkRO object. A Link pointing to a resource
        {
        • "name":
          string
          the name of the returned element
        • "type":
          string
          Readonly | This is a constant: Link | Example: Link
        • "attributes":
          array
          An array of ResourceAttribute objects. the list of attributes
          [
          ResourceAttribute: An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
          ]
        • "uri":
          string
          The uri
        • "relation":
          string
          The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
        • "title":
          string
          The title of the link
        • "description":
          string
          The description of the link
        • "itemId":
          string
          the Id of the linked item
        • "attribute":
          object
          A ResourceAttribute object. An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
        }
      • "hits":
        object
        A LinkRO object. A Link pointing to a resource
        {
        • "name":
          string
          the name of the returned element
        • "type":
          string
          Readonly | This is a constant: Link | Example: Link
        • "attributes":
          array
          An array of ResourceAttribute objects. the list of attributes
          [
          ResourceAttribute: An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
          ]
        • "uri":
          string
          The uri
        • "relation":
          string
          The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
        • "title":
          string
          The title of the link
        • "description":
          string
          The description of the link
        • "itemId":
          string
          the Id of the linked item
        • "attribute":
          object
          A ResourceAttribute object. An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
        }
      • "selected":
        boolean
      }
      ]
    • "displayType":
      string
      Display type | Example: text_clear
    • "selectionType":
      string
      Selection type | Example: taxonomic
    • "limitCount":
      integer
      Limit count | Format: int32 | Example: -1
    • "minCount":
      integer
      Minimum count | Format: int32 | Example: 1
    • "links":
      object
    • "scope":
      string
      Scope of filter | Example: Global
    }
    ]
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "name":
    string
    The name of an element.
}
ResourceCollectionROLinkRO application/json{
  • "pageable":
    string
    the pageable ID
  • "total":
    integer
    the pageable amount total | Format: int32
  • "offset":
    integer
    the pageable offset | Format: int32
  • "amount":
    integer
    the pageable amount | Format: int32
  • "elements":
    array
    An array of LinkRO objects. the list of elements
    [
    LinkRO: A Link pointing to a resource
    {
    • "name":
      string
      the name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The uri
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      the Id of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "type":
    string
    This is a constant: ResourceCollection | Example: ResourceCollection
  • "sortKeys":
    array
    An array of string literals. the keys to sort for
  • "name":
    string
    the name of the returned element
}
ResourceCollectionROTypedLinkRO application/json{
  • "pageable":
    string
    The pageable ID
  • "total":
    integer
    The pageable amount total | Format: int32
  • "offset":
    integer
    The pageable offset | Format: int32
  • "amount":
    integer
    The pageable amount | Format: int32
  • "elements":
    array
    An array of TypedLinkRO objects. The list of elements
    [
    TypedLinkRO: the list of elements
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "linkType":
      string
    • "categoryLinks":
      array
      An array of LinkRO objects.
      [
      LinkRO: A Link pointing to a resource
      {
      • "name":
        string
        the name of the returned element
      • "type":
        string
        Readonly | This is a constant: Link | Example: Link
      • "attributes":
        array
        An array of ResourceAttribute objects. the list of attributes
        [
        ResourceAttribute: An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
        ]
      • "uri":
        string
        The uri
      • "relation":
        string
        The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
      • "title":
        string
        The title of the link
      • "description":
        string
        The description of the link
      • "itemId":
        string
        the Id of the linked item
      • "attribute":
        object
        A ResourceAttribute object. An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
      }
      ]
    • "productLinks":
      array
      An array of LinkRO objects.
      [
      LinkRO: A Link pointing to a resource
      {
      • "name":
        string
        the name of the returned element
      • "type":
        string
        Readonly | This is a constant: Link | Example: Link
      • "attributes":
        array
        An array of ResourceAttribute objects. the list of attributes
        [
        ResourceAttribute: An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
        ]
      • "uri":
        string
        The uri
      • "relation":
        string
        The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
      • "title":
        string
        The title of the link
      • "description":
        string
        The description of the link
      • "itemId":
        string
        the Id of the linked item
      • "attribute":
        object
        A ResourceAttribute object. An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
      }
      ]
    }
    ]
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "name":
    string
    The name of an element.
}
TypedLinksCollectionRO application/json{
  • "pageable":
    string
    The pageable ID
  • "total":
    integer
    The pageable amount total | Format: int32
  • "offset":
    integer
    The pageable offset | Format: int32
  • "amount":
    integer
    The pageable amount | Format: int32
  • "elements":
    array
    An array of TypedLinkRO objects. The list of elements
    [
    TypedLinkRO: the list of elements
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "linkType":
      string
    • "categoryLinks":
      array
      An array of LinkRO objects.
      [
      LinkRO: A Link pointing to a resource
      {
      • "name":
        string
        the name of the returned element
      • "type":
        string
        Readonly | This is a constant: Link | Example: Link
      • "attributes":
        array
        An array of ResourceAttribute objects. the list of attributes
        [
        ResourceAttribute: An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
        ]
      • "uri":
        string
        The uri
      • "relation":
        string
        The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
      • "title":
        string
        The title of the link
      • "description":
        string
        The description of the link
      • "itemId":
        string
        the Id of the linked item
      • "attribute":
        object
        A ResourceAttribute object. An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
      }
      ]
    • "productLinks":
      array
      An array of LinkRO objects.
      [
      LinkRO: A Link pointing to a resource
      {
      • "name":
        string
        the name of the returned element
      • "type":
        string
        Readonly | This is a constant: Link | Example: Link
      • "attributes":
        array
        An array of ResourceAttribute objects. the list of attributes
        [
        ResourceAttribute: An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
        ]
      • "uri":
        string
        The uri
      • "relation":
        string
        The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
      • "title":
        string
        The title of the link
      • "description":
        string
        The description of the link
      • "itemId":
        string
        the Id of the linked item
      • "attribute":
        object
        A ResourceAttribute object. An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
      }
      ]
    }
    ]
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "name":
    string
    The name of an element.
}
VariationCollectionRO application/json{
  • "pageable":
    string
    The pageable ID
  • "total":
    integer
    The pageable amount total | Format: int32
  • "offset":
    integer
    The pageable offset | Format: int32
  • "amount":
    integer
    The pageable amount | Format: int32
  • "elements":
    array
    An array of VariationLinkRO objects. The list of elements
    [
    VariationLinkRO: the list of elements
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
    • "relation":
      string
      Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
    • "description":
      string
    • "itemId":
      string
    • "variableVariationAttributeValues":
      array
      An array of VariationAttributeRO objects.
      [
      VariationAttributeRO
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
      • "attributes":
        array
        An array of ResourceAttribute objects. the list of attributes
        [
        ResourceAttribute: An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
        ]
      • "value":
        string
      • "variationAttributeId":
        string
      • "attribute":
        object
        A ResourceAttribute object. An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
      }
      ]
    • "variableVariationAttributeValuesExtended":
      array
      An array of VariationAttributeExtendedRO objects.
      [
      VariationAttributeExtendedRO
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
      • "attributes":
        array
        An array of ResourceAttribute objects. the list of attributes
        [
        ResourceAttribute: An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
        ]
      • "variationAttributeId":
        string
      • "value":
        object
        A AttachmentAttributeROObject object.
        {
        • "type":
          string
          The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
        • "name":
          string
          The name of an element.
        • "value":
          object
        }
      • "values":
        array
        An array of VariationAttributeValueRO objects.
        [
        VariationAttributeValueRO
        {
        • "name":
          string
          The name of an element.
        • "type":
          string
          Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
        • "attributes":
          array
          An array of ResourceAttribute objects. the list of attributes
          [
          ResourceAttribute: An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
          ]
        • "value":
          object
          A AttachmentAttributeROObject object.
          {
          • "type":
            string
            The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
          • "name":
            string
            The name of an element.
          • "value":
            object
          }
        • "metadata":
          object
          A MetadataRO object.
          {
          • "name":
            string
            The name of an element.
          • "type":
            string
            Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
          • "attributes":
            array
            An array of ResourceAttribute objects. the list of attributes
            [
            ResourceAttribute: An attribute
            {
            • "name":
              string
              The attribute's name
            • "type":
              string
              This is a constant: ResourceAttribute | Example: ResourceAttribute
            • "value":
              object
              The attribute's value.
            }
            ]
          • "colorCode":
            string
          • "imagePath":
            string
          • "attribute":
            object
            A ResourceAttribute object. An attribute
            {
            • "name":
              string
              The attribute's name
            • "type":
              string
              This is a constant: ResourceAttribute | Example: ResourceAttribute
            • "value":
              object
              The attribute's value.
            }
          }
        • "attribute":
          object
          A ResourceAttribute object. An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
        }
        ]
      • "attributeType":
        string
      • "metadata":
        object
        A MetadataRO object.
        {
        • "name":
          string
          The name of an element.
        • "type":
          string
          Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
        • "attributes":
          array
          An array of ResourceAttribute objects. the list of attributes
          [
          ResourceAttribute: An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
          ]
        • "colorCode":
          string
        • "imagePath":
          string
        • "attribute":
          object
          A ResourceAttribute object. An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
        }
      • "attribute":
        object
        A ResourceAttribute object. An attribute
        {
        • "name":
          string
          The attribute's name
        • "type":
          string
          This is a constant: ResourceAttribute | Example: ResourceAttribute
        • "value":
          object
          The attribute's value.
        }
      }
      ]
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "name":
    string
    The name of an element.
}

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Tickets