Product
Fetch a single product
POST /product/{productId} | ProductDetailRoute
Parameters
Path
navigationId | uuid | required
Identifier of a product. If it points to a "parent" product, it returns the cheapest variant of that product.
Body
Search Criteria | Criteria | optional
Returns
Returns a single product together with a configurator object that contains its variant options.
Fetch a list of products by category
POST /product-listing/{categoryId} | ProductListingRoute
Parameters
Path
navigationId | uuid | required
Identifier of a category.
Body
Search Criteria | Criteria | optional
Returns
Returns a product listing containing all products and additional fields to display a listing.
Fetch a list of products by criteria
POST /product | ProductListListRoute
Parameters
Body
Search Criteria | Criteria | optional
Returns
Returns a search result containing products, aggregations and pagination properties.
Fetch cross-selling groups of a product
POST /product/{productId}/cross-selling | ProductCrossSellingRoute
Parameters
Path
productId | uuid | required
Identifier of a product.
Body
includes | object | optional
Returns
Returns a list of cross-selling groups for the given product including their respective items.
Search for products
POST /search | ProductSearchRoute
POST /search-suggest | ProductSuggestRoute
Parameters
Body
search | string | required
Term to search after.
Search Criteria | Criteria | optional
Returns
Returns a product listing including all products that match your search term. Additionally, all products contain a extensions.search._score field, which shows the relevance score of the product.
When you're using the /search-suggest endpoint, aggregations, currentFilters and availableSortings are not included in the response.
Fetch product reviews
POST /product/{productId}/reviews | ProductReviewRoute
Parameters
Path
productId | uuid | required
Identifier of a product.
Body
Search Criteria | Criteria | optional
Returns
Returns a search result containing all reviews for the given product.
Save product reviews
POST /product/{productId}/review | ProductReviewSaveRoute
Parameters
Header
sw-context-token | string | required
Context token of a logged in user.
Path
productId | uuid | required
Identifier of a product.
Body
title | string | required
Identifier of a product.
content | string | required
Identifier of a product.
id | uuid | optional
Used for edits only. The review will be updated, if it's created by the logged in user.
name | string | optional
Name of the reviewer. If not set, it defaults to the customer's first name.
email | string | optional
Identifier of a product. If not set, it defaults to the customer's email
points | float | optional
Identifier of a product.
Returns
Returns an empty when the response was created or modified.
