Retrieve product recommendations

Obtain personalized product recommendations from the Kameleoon Product Recommendation API using recommender codes.

GET /endpoint

Retrieve product recommendations

cURL

curl --request GET \
  --url https://api.example.com/endpoint

import requests

url = "https://api.example.com/endpoint"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/endpoint', 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.example.com/endpoint",
  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.example.com/endpoint"

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/endpoint")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/endpoint")

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

This endpoint retrieves product recommendations.

Request

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

Query parameters

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.

Response

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.