Retrieve collection

curl --request GET \
  --url https://api.products.kameleoon.com/collection/{collection_id}

const options = {method: 'GET'};

fetch('https://api.products.kameleoon.com/collection/{collection_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.products.kameleoon.com/collection/{collection_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.products.kameleoon.com/collection/{collection_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.products.kameleoon.com/collection/{collection_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "products": [
    {
      "name": "<string>",
      "url": "<string>",
      "category_ids": [
        "<string>"
      ],
      "barcode": "<string>",
      "vendor_code": "<string>",
      "brand": "<string>",
      "leftovers": "<string>",
      "rating": 123,
      "fashion_feature": "<string>",
      "fashion_wear_type": "<string>",
      "fashion_original_sizes": [
        "<string>"
      ],
      "picture": "<string>",
      "categories": [
        {
          "id": "<string>",
          "parent_id": "<string>",
          "url": "<string>",
          "name": "<string>",
          "level": "<string>",
          "url_handle": "<string>"
        }
      ],
      "price_formatted": "<string>",
      "price_full_formatted": "<string>",
      "price": 123,
      "price_full": 123,
      "image_url": "<string>",
      "image_url_handle": "<string>",
      "image_url_resized": {},
      "url_handle": "<string>",
      "currency": "<string>",
      "_id": "<string>",
      "id": "<string>",
      "stock_quantity": 123,
      "fashion_colors": [
        "<string>"
      ],
      "params": "<array>",
      "group_id": "<string>"
    }
  ],
  "html": "<string>"
}

GET

collection

{collection_id}

Retrieve collection

curl --request GET \
  --url https://api.products.kameleoon.com/collection/{collection_id}

const options = {method: 'GET'};

fetch('https://api.products.kameleoon.com/collection/{collection_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.products.kameleoon.com/collection/{collection_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.products.kameleoon.com/collection/{collection_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.products.kameleoon.com/collection/{collection_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "products": [
    {
      "name": "<string>",
      "url": "<string>",
      "category_ids": [
        "<string>"
      ],
      "barcode": "<string>",
      "vendor_code": "<string>",
      "brand": "<string>",
      "leftovers": "<string>",
      "rating": 123,
      "fashion_feature": "<string>",
      "fashion_wear_type": "<string>",
      "fashion_original_sizes": [
        "<string>"
      ],
      "picture": "<string>",
      "categories": [
        {
          "id": "<string>",
          "parent_id": "<string>",
          "url": "<string>",
          "name": "<string>",
          "level": "<string>",
          "url_handle": "<string>"
        }
      ],
      "price_formatted": "<string>",
      "price_full_formatted": "<string>",
      "price": 123,
      "price_full": 123,
      "image_url": "<string>",
      "image_url_handle": "<string>",
      "image_url_resized": {},
      "url_handle": "<string>",
      "currency": "<string>",
      "_id": "<string>",
      "id": "<string>",
      "stock_quantity": 123,
      "fashion_colors": [
        "<string>"
      ],
      "params": "<array>",
      "group_id": "<string>"
    }
  ],
  "html": "<string>"
}

Service provides access to product collection endpoint.

You can find the product collection_id in the Product Collections section of the dashboard, which lists your configured collections along with their ID numbers.

Query parameters

Parameter	Type	Required	Description
`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.
`did`	String	False	Device ID. You can find this ID in the cookie `KameleoonProducts_device_id`, which you can retrieve from the backend before calling this endpoint.
`location`	String	False	User’s location.
`sid`	String	False	Temporary user session ID. Get this ID from the `KameleoonProducts_session_code` cookie. Retrieve it from the backend before calling this endpoint.
`external_id`	String	False	A unique identifier associated with a user in your system or CRM. (To ensure accurate matching with Kameleoon VisitorCode, you must first store the ID as 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 so Kameleoon uses the ID to link user activities across both systems.)

Response

Name	Type	Description
`products`	Array of objects	Array with information about products. Each object has the following properties.
`html`	String	The HTML template you selected when you created the collection

List of fields for `products` array of objects

Property	Description
`name`	Product name
`url`	Full URL to the product page
`category_ids`	List of associated category IDs
`barcode`	Product barcode or unique identifier
`vendor_code`	Vendor or brand code
`brand`	Brand name
`leftovers`	Stock type, such as `lot` or `single`
`rating`	Product rating
`fashion_feature`	Fashion feature or target audience, such as `child` or `woman`
`fashion_wear_type`	Type of fashion item, such as `shoe` or `clothing`
`fashion_original_sizes`	Original available sizes
`picture`	Default image URL
`categories`	Product categories (array). Has the following properties.
`price_formatted`	Product price formatted as a string, for example `$ 70`
`price_full_formatted`	Full product price formatted as a string, for example `$ 70.00`
`price`	Product price as a number
`price_full`	Full product price as a number
`image_url`	Main image URL
`image_url_handle`	Relative path to the main image
`image_url_resized`	Object with URLs of resized images by size
`url_handle`	Relative path to the product page
`currency`	Currency symbol, for example `$`
`_id`	Internal unique identifier
`id`	Product ID (often the same as the barcode)
`stock_quantity`	Available stock quantity
`fashion_colors`	Available colors for the product
`params`	List of key/value pairs representing product attributes, such as size or color
`group_id`	ID of the group the product belongs to

List of properties for `categories` array

Property	Description
`id`	Category ID
`parent_id`	(Optional) ID of the parent category (if applicable)
`url`	Full URL of the category
`name`	Category name
`level`	Category level: `1` for a parent category, `2` for a subcategory
`url_handle`	Relative URL path to the category

Path Parameters

collection_id

string

required

The ID of the product collection to retrieve.

Query Parameters

shop_id

string

required

Store Key. Find this in Recommendations > Settings > Store settings in the Kameleoon app. Contact your Customer Success Manager for the key if necessary.

did

string

Device ID. You can find this ID in the cookie KameleoonProducts_device_id, retrieved from the back end before calling this endpoint.

sid

string

Temporary user session ID. Get this ID from the KameleoonProducts_session_code cookie. Retrieve it from the backend before calling this endpoint. Not independently verified live for this endpoint; added for consistency with the documented query-parameter table.

location

string

User's location.

external_id

string

Unique identifier associated with a user in your system or CRM. To ensure accurate matching with the Kameleoon VisitorCode, store this ID as Kameleoon Custom Data with "Use this custom data as a unique identifier for cross-device matching" enabled.

Response

200 - application/json

The collection's products and HTML template.

products

object[]

Information about the products in the collection.

Show child attributes

html

string

The HTML template selected when the collection was created.

⌘I

​Query parameters

​Response

​List of fields for products array of objects

​List of properties for categories array

Path Parameters

Query Parameters

Response

Query parameters

Response

List of fields for `products` array of objects

List of properties for `categories` array