Get product recommendations
Use this endpoint to retrieve products related to a given source product.
Optional parameters
filter[price][gte]/filter[price][lte]- restrict recommendations to a price range. Both bounds must be supplied together.collectionId- restrict recommendations to products in a given collection.page[limit]- control the size of the returned set (0-20).include=brand,tags- return related entities in each recommended product.
Please note
- At most
page[limit]products are returned. - This endpoint is not paginated.
- Returns
404(404_PROD_001) when the sourceproductIddoes not exist. - Returns
422(422_PBLC_003) whencollectionIdreferences a collection that does not exist or is not accessible.
Permissions
- Requires:
products:read
Authorizations
Company Level Authentication
Include your API key in the X-Api-Key header for every request:
X-Api-Key: YOUR_API_KEYHeaders
Optional account identifier for swag validation/filtering.
"acc123456"
Optional company identifier for swag validation/filtering.
"cmp123456"
Path Parameters
Stable identifier of the source product.
^[A-Za-z0-9]{8,}$"655277e68e0719000d6c3fd5"
Query Parameters
ISO 3166-1 alpha-2 country code used to scope pricing and availability.
^[A-Z]{2}$"US"
Inclusive minimum price. Must be sent together with filter[price][lte].
x >= 010
Inclusive maximum price. Must be sent together with filter[price][gte].
x >= 050
Restrict recommendations to products belonging to the given collection.
"6527bb3567f414000c15d2c7"
Maximum number of recommendations to return.
0 <= x <= 2010
Comma-separated related entities to expand in each recommended product.
Related entities to include.
brand, tags ["brand", "tags"]Response
Recommended products.
Product recommendations response.
Recommended products, ordered by relevance. Empty when no qualifying recommendations are found.