GET /catalog/v4/recommendations

The recommendation operation returns product IDs or products that are recommended based on an input product id. The operation returns a maximum of 20 recommendations.

Request URL structure:

https://api.bol.com/catalog/v4/recommendations/{productId}

Request HTTP method:

GET

Request requires session:

No

Request parameters:

Name Location Data type Required Description

productid

Path

Number

Yes

The product ID for which the recommendations are given

includeattributes

Query

Boolean

No

Return the full set of attributes for the products as key-value pairs. Note that by using the key-value pairs, more attributes are available as key-value pair than as elements.

– “true”: return key-value pair attributes
– “false”: return no key-value pair attributes

Default is true.

offers

Query

Boolean

No

all, cheapest, secondhand, newoffers, bolcom – default: bestoffer. The parameters can be combined using a comma, for instance offers=cheapest,secondhand returns the cheapest 2nd hand offer. Note that bestoffer returns only the best offer, making further filtering pointless

limit

Query

number

No

Request a number of recommendations that will be returned. Note that the max products is 20, but fewer recommendations may be available. Default is 10.

offset

Query

number

No

Skip the first n recommendations.

format

Query

Text

No

json (default): the response is returned in JSON. xml: the response is returned in XML

country

Query

Text

No

Signifies whether the shopping context is Dutch (NL; default) or Belgium (BE). This can influence search ranking, and whether some products and offers are returned

Response:

Element Min Max Description

Products

0

20

List of products recommended, max. 20.

ProductIDs

0

20

List of product IDs recommended, max 20 (Note that product and product ID are mutually exclusive in the response, which can be signalled with the includeProducts parameter)

Request / Response example:

https://api.bol.com/catalog/v4/recommendations/1000004012998793/?apikey={apikey}&format=json&limit=2

Response HTTP status code: 200

Example response: JSONXML