Retrieve recommended collection

Service provides access to product collection endpoint.

HTTP Request

GET https://api.products.kameleoon.com/collection/{%ID%}

note

You can find the product collection ID in the Product Collections section of the dashboard. Your configured collections are listed there along with their ID numbers.

Query Parameters

Parameter	Type	Required	Description
shop_id	String	True	Your Store Key. You can find this in Recommendations > Settings > Store settings in the Kameleoon app. You can also contact your Customer Success Manager for the key.
did	String	False	Device ID. You can find this ID in the cookie KameleoonProducts_device_id, which you can retrieve from the back-end before calling this endpoint.
location	String	False	User's location.
external_id	String	False	This is a unique identifier associated with a user in your system or CRM. (To ensure accurate matching with Kameleoon VisitorCode, the ID must first be stored as a Kameleoon Custom Data. When setting up this custom data, make sure to enable the option Use this custom data as a unique identifier for cross-device matching to ensure that the ID is used to link user activities across both systems.).

API Response

Name	Type	Description
name	String	Name of the product
url	String	URL to the product page
description	String	Description of the product
category_ids	Array of Strings	Array of category IDs the product belongs to
brand	String	Brand of the product
fashion_feature	String	Fashion feature (e.g., "adult").
fashion_gender	String	Gender for which the product is intended
sales_rate	Integer	Sales rate
relative_sales_rate	Float	Relative sales rate compared to other products
picture	String (URL)	URL of the product image
categories	Array of Objects	Array of category objects the product belongs to (system object)
price_formatted	String	Formatted price
price_full_formatted	String	Formatted full price
price	Float	Price of the product
price_full	Float	Full price of the product
image_url	String (URL)	URL to the resized product image
image_url_handle	String (URL)	Processed image URL
image_url_resized	String (URL)	Resized image URL
url_handle	String	URL handle to access the product within the collection
currency	String	Currency used for the price
id	String	Product ID/SKU
html	String (HTML)	The HTML template selected when the collection was created