Skip to main content

Retrieve recommended collection

Service provides access to product collection endpoint.

HTTP Request

GET https://api.products.kameleoon.com/collection/{%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

ParameterTypeRequiredDescription
shop_idStringTrueYour 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.
didStringFalseDevice ID. You can find this ID in the cookie KameleoonProducts_device_id, which you can retrieve from the back-end before calling this endpoint.
locationStringFalseUser's location.
external_idStringFalseThis 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

NameTypeDescription
productsArray of objectsArray with information about products. Each object has the following properties.
htmlStringThe HTML template selected when the collection was created

List of fields for products array of objects

PropertyDescription
nameProduct name
urlFull URL to the product page
category_idsList of associated category IDs
barcodeProduct barcode or unique identifier
vendor_codeVendor or brand code
brandBrand name
leftoversIndicates stock type (e.g., "lot", "single", etc.)
ratingProduct rating
fashion_featureFashion feature or target audience (e.g., child, woman)
fashion_wear_typeType of fashion item (e.g., shoe, clothing)
fashion_original_sizesOriginal available sizes
pictureDefault image URL
categoriesProduct categories (array). Has the following properties.
price_formattedProduct price formatted as a string (e.g., "$ 70")
price_full_formattedFull product price formatted as a string (e.g., "$ 70.00")
priceProduct price as a number
price_fullFull product price as a number
image_urlMain image URL
image_url_handleRelative path to the main image
image_url_resizedObject with URLs of resized images by size
url_handleRelative path to the product page
currencyCurrency symbol (e.g., "$")
_idInternal unique identifier
idProduct ID (often the same as the barcode)
stock_quantityAvailable stock quantity
fashion_colorsAvailable color(s) for the product
paramsList of key/value pairs representing product attributes (e.g., size, color)
group_idID of the group the product belongs to

List of properties for categories array

PropertyDescription
idCategory ID
parent_id(Optional) ID of the parent category (if applicable)
urlFull URL of the category
nameCategory name
levelCategory level (e.g., "1" = parent, "2" = subcategory)
url_handleRelative URL path to the category