Retrieve product recommendations - Kameleoon Documentation

This endpoint retrieves product recommendations.

GET https://api.products.kameleoon.com/recommend/{%recommender_code%}

Parameter	Type	Required	Description
`did`	String	True	Device ID. Get this ID from the `KameleoonProducts_device_id` cookie. Retrieve it from the backend before calling this endpoint. Only provide `did` when using filters or algorithms that rely on historical device data, such as “Recently Viewed” or “Recommended for You.”
`shop_id`	String	True	Store Key. Find this in Recommendations > Settings > Store settings in the Kameleoon app. Contact your Customer Success Manager for the key if necessary.
`sid`	String	True	Temporary user session ID. Get this ID from the `KameleoonProducts_session_code` cookie. Retrieve it from the backend before calling this endpoint. Only provide `sid` when using filters or algorithms that rely on historical user data, such as “Recently Viewed” or “Recommended for You.”
`recommender_code`	String	True	ID of the product recommendations block. Find the `recommender_code` in the blocks management UI.
`resize_image`	Integer	Optional	Image size (px) for resizing. Supported values: `120`, `140`, `160`, `180`, `200`, `220`.
`extended`	Integer or empty	Optional	Adds extended information for recommended products. If `1`, the API returns all product information. If empty, the API returns only product IDs.
`with_locations`	Boolean	False	If `true` and the `extended` parameter is also `true`, the response includes `location_ids` for all availability places. If `extended` is missing or `false`, the API ignores `with_locations` and defaults to `false`.

Name	Type	Description
`html`	string	HTML code for the product block. Customize the HTML template in the Kameleoon personal account.
`title`	string	Block title. Matches the “Action” element value in the block rules.
`recommends`	array	List of product IDs.
`id`	number	Unique block identifier. Matches the block ID in the Kameleoon personal account.

Documentation Index