Retrieve search results - Kameleoon Documentation

The Kameleoon Search service provides two search types:

Instant (typeahead) search: Displays and updates results as users type search queries.
Full search: Returns complete, filtered search results after the user submits a search query.

Both options use the same endpoint. Use the type parameter to specify the search type.

Request

GET https://api.products.kameleoon.com/search

Query parameters

These query parameters apply to both full search and instant search. Use additional parameters only with full search.

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.”
`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.”
`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.
`type`	String	True	Specifies the search type: `instant_search` or `full_search`.
`search_query`	String	True	Current search query.
`locations`	List	Optional	Comma-separated list of location IDs.

Additional query parameters (full search only)

Use these additional parameters with full search requests (type=full_search).

Parameter	Type	Required	Description
`limit`	Integer	Optional	Maximum number of results the API returns.
`offset`	Integer	Optional	Result offset.
`category_limit`	Integer	Optional	Maximum number of categories for the sidebar filter.
`categories`	List	Optional	Comma-separated list of categories for filtering.
`extended`	Integer or empty	Optional	Adds extended information for product results. Supported values: `1` or empty. If `1`, the API returns all product information. If empty, the API returns only product IDs. Kameleoon recommends setting this to `1` for full search.
`sort_by`	String	Optional	Sorting parameter. Supported values: `popular`, `price`, `discount`, `sales_rate`, `date`.
`order`	String	Optional	Sort direction: `asc` (ascending) or `desc` (descending). Default is `desc`.
`brands`	List	Optional	Comma-separated list of brands for filtering.
`filters`	String	Optional	Escaped JSON string with filter parameters. Example: `{"bluetooth":["yes"],"offers":["15% cashback"],"weight":["1.6"]}`
`price_min`	Integer	Optional	Minimum price.
`price_max`	Integer	Optional	Maximum price.
`colors`	Integer	Optional	Comma-separated list of colors.
`exclude`	Integer	Optional	Comma-separated list of product IDs to exclude from search results.

Response (instant search)

Name	Type	Description
`search_query`	string	Search query.
`categories`	array	Category information. Each object contains these properties: `id` – category ID (string) `name` – category name (string) `url` – category URL (string) `count` – number of products in the category (number)
`filters`	array	Filter information. Each object contains these properties: `filter` – Filter object containing these properties: `count` – total products matching these parameters (number) `values` – array of value objects containing these properties: `value` – value label (string) `count` – number of products with this parameter (number)
`html`	string	HTML code for the product block. Customize the template in the Kameleoon personal account.
`price_range`	object	Minimum and maximum product prices. Contains these properties: `min` – minimum price (number) `max` – maximum price (number)
`products`	array	Product information. Each object contains these properties: `description` – product description (string) `url` – absolute product URL (string) `url_handle` – relative product URL (string) `picture` – product picture URL in Kameleoon storage (string) `name` – product name (string) `price` – product price (integer) `price_full` – product price (float) `price_formatted` – product price with currency (string) `price_full_formatted` – formatted product price with currency (string) `image_url` - absolute product picture URL in Kameleoon storage (string) `image_url_handle` - relative product picture URL in Kameleoon storage (string) `image_url_resized` - array of resized image URLs `currency` – product currency (string) `id` – product ID (string) `old_price` – product old price (integer, default is 0) `old_price_full` – product old price (float) `old_price_formatted` – product old price with currency (string) `old_price_full_formatted` – formatted product old price with currency (string) Additional properties if you include `extended` in the request: `id` – category ID (string) `name` – category name (string) `parent_id` – parent category ID (string) `url` - category URL `category_ids` - product category IDs (array)
`search_query_redirects`	array	Redirect information. Each object contains these properties: `query` – search query (string) `redirect_link` – URL for redirection (string) `deep_link` – URL for mobile apps (string)
`products_total`	number	Total number of products.

Response (full search)

Name	Type	Description
`brands`	array	Brand information. Each object contains these properties: `name` – brand name (string) `picture` – brand picture URL (string)
`categories`	array	Category information. Each object contains these properties: `alias` – category alias (string) `id` – category ID (string) `name` – category name (string) `parent` – parent category ID (string) `url` – category URL (string)
`filters`	array	Filter information. Each object contains these properties: `filter` – Filter object containing these properties: `count` – total products matching these parameters (number) `values` – value objects containing `value` (string) and `count` (number)
`html`	string	HTML code for the product block. Customize the template in the Kameleoon personal account.
`price_range`	object	Minimum and maximum product prices. Contains these properties: `min` – minimum price (number) `max` – maximum price (number)
`products`	array	Product information. Each object contains these properties: `brand` – product brand (string) `currency` – product currency (string) `id` – product ID (string) `is_new` – product property (boolean, default is null) `name` – product name (string) `old_price` – product old price (string, default is 0) `picture` – product picture URL in Kameleoon storage (string) `price` – product price (number) `price_formatted` – product price with currency (string) `url` – product URL (string) Additional properties if you include `extended` in the request: `barcode` – product barcode (string) `categories` – product categories (array) containing `id`, `name`, and `parent` ID. `params` – parameter information. Each object contains `key` (string) and `values` (array).
`products_total`	number	Total count of products.
`search_query`	string	Search query.

APIs

Documentation Index

​Request

​Query parameters

​Additional query parameters (full search only)

​Response (instant search)

​Response (full search)

Request

Query parameters

Additional query parameters (full search only)

Response (instant search)

Response (full search)