Recuperar resultados de búsqueda - Kameleoon Documentation

Retrieve search results

curl --request GET \
  --url https://api.products.kameleoon.com/search

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.products.kameleoon.com/search",
  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/search"

	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/search")

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

{
  "search_query": "<string>",
  "search_query_original": "<string>",
  "collections": [
    {}
  ],
  "categories": [
    {
      "id": "<string>",
      "name": "<string>",
      "url": "<string>",
      "url_handle": "<string>",
      "count": 123,
      "parent": "<string>",
      "alias": "<string>"
    }
  ],
  "filters": {},
  "html": "<string>",
  "price_range": {
    "min": 123,
    "max": 123
  },
  "price_ranges": [
    {
      "from": 123,
      "to": 123,
      "count": 123
    }
  ],
  "price_median": 123,
  "products": [
    {
      "name": "<string>",
      "url": "<string>",
      "url_handle": "<string>",
      "category_ids": [
        "<string>"
      ],
      "categories": [
        {
          "id": "<string>",
          "url": "<string>",
          "name": "<string>",
          "level": "<string>",
          "url_handle": "<string>"
        }
      ],
      "barcode": "<string>",
      "vendor_code": "<string>",
      "brand": "<string>",
      "leftovers": "<string>",
      "rating": 123,
      "fashion_feature": "<string>",
      "fashion_gender": "<string>",
      "fashion_wear_type": "<string>",
      "fashion_sizes": [
        "<string>"
      ],
      "fashion_original_sizes": [
        "<string>"
      ],
      "fashion_colors": [
        "<string>"
      ],
      "picture": "<string>",
      "price_formatted": "<string>",
      "price_full_formatted": "<string>",
      "price": 123,
      "price_full": 123,
      "image_url": "<string>",
      "image_url_handle": "<string>",
      "image_url_resized": {},
      "currency": "<string>",
      "_id": "<string>",
      "id": "<string>",
      "stock_quantity": 123,
      "params": [
        {
          "key": "<string>",
          "values": [
            "<string>"
          ]
        }
      ],
      "group_id": "<string>",
      "description": "<string>",
      "is_new": true,
      "old_price": "<string>",
      "sales_rate": 123,
      "relative_sales_rate": 123
    }
  ],
  "products_total": 123,
  "search_query_redirects": [
    {
      "query": "<string>",
      "redirect_link": "<string>",
      "deep_link": "<string>"
    }
  ],
  "brands": [
    {
      "name": "<string>",
      "picture": "<string>",
      "count": 123
    }
  ],
  "clarification": true,
  "requests_count": 123,
  "queries": [
    {
      "name": "<string>",
      "url": "<string>",
      "url_handle": "<string>",
      "score": 123
    }
  ],
  "industrial_filters": {
    "fashion_sizes": [
      {
        "size": "<string>",
        "count": 123
      }
    ],
    "colors": [
      {
        "color": "<string>",
        "count": 123
      }
    ]
  }
}

GET

Retrieve search results

curl --request GET \
  --url https://api.products.kameleoon.com/search

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.products.kameleoon.com/search",
  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/search"

	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/search")

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

{
  "search_query": "<string>",
  "search_query_original": "<string>",
  "collections": [
    {}
  ],
  "categories": [
    {
      "id": "<string>",
      "name": "<string>",
      "url": "<string>",
      "url_handle": "<string>",
      "count": 123,
      "parent": "<string>",
      "alias": "<string>"
    }
  ],
  "filters": {},
  "html": "<string>",
  "price_range": {
    "min": 123,
    "max": 123
  },
  "price_ranges": [
    {
      "from": 123,
      "to": 123,
      "count": 123
    }
  ],
  "price_median": 123,
  "products": [
    {
      "name": "<string>",
      "url": "<string>",
      "url_handle": "<string>",
      "category_ids": [
        "<string>"
      ],
      "categories": [
        {
          "id": "<string>",
          "url": "<string>",
          "name": "<string>",
          "level": "<string>",
          "url_handle": "<string>"
        }
      ],
      "barcode": "<string>",
      "vendor_code": "<string>",
      "brand": "<string>",
      "leftovers": "<string>",
      "rating": 123,
      "fashion_feature": "<string>",
      "fashion_gender": "<string>",
      "fashion_wear_type": "<string>",
      "fashion_sizes": [
        "<string>"
      ],
      "fashion_original_sizes": [
        "<string>"
      ],
      "fashion_colors": [
        "<string>"
      ],
      "picture": "<string>",
      "price_formatted": "<string>",
      "price_full_formatted": "<string>",
      "price": 123,
      "price_full": 123,
      "image_url": "<string>",
      "image_url_handle": "<string>",
      "image_url_resized": {},
      "currency": "<string>",
      "_id": "<string>",
      "id": "<string>",
      "stock_quantity": 123,
      "params": [
        {
          "key": "<string>",
          "values": [
            "<string>"
          ]
        }
      ],
      "group_id": "<string>",
      "description": "<string>",
      "is_new": true,
      "old_price": "<string>",
      "sales_rate": 123,
      "relative_sales_rate": 123
    }
  ],
  "products_total": 123,
  "search_query_redirects": [
    {
      "query": "<string>",
      "redirect_link": "<string>",
      "deep_link": "<string>"
    }
  ],
  "brands": [
    {
      "name": "<string>",
      "picture": "<string>",
      "count": 123
    }
  ],
  "clarification": true,
  "requests_count": 123,
  "queries": [
    {
      "name": "<string>",
      "url": "<string>",
      "url_handle": "<string>",
      "score": 123
    }
  ],
  "industrial_filters": {
    "fashion_sizes": [
      {
        "size": "<string>",
        "count": 123
      }
    ],
    "colors": [
      {
        "color": "<string>",
        "count": 123
      }
    ]
  }
}

El servicio Kameleoon Search ofrece dos tipos de búsqueda:

Búsqueda instantánea (typeahead): Muestra y actualiza los resultados a medida que los usuarios escriben las consultas de búsqueda.
Búsqueda completa: Devuelve los resultados de búsqueda completos y filtrados después de que el usuario envíe una consulta de búsqueda.

Ambas opciones utilizan el mismo endpoint. Use el parámetro type para especificar el tipo de búsqueda.

Parámetros de consulta

Estos parámetros de consulta se aplican tanto a la búsqueda completa como a la búsqueda instantánea. Utilice parámetros adicionales solo con la búsqueda completa.

Parámetro	Tipo	Obligatorio	Descripción
`did`	String	True	Device ID. Obtenga este ID de la cookie `KameleoonProducts_device_id`. Recupérelo desde el backend antes de llamar a este endpoint. Proporcione `did` solo cuando utilice filtros o algoritmos que dependan de datos históricos del dispositivo, como “Recently Viewed” o “Recommended for You”.
`sid`	String	True	ID de sesión temporal del usuario. Obtenga este ID de la cookie `KameleoonProducts_session_code`. Recupérelo desde el backend antes de llamar a este endpoint. Proporcione `sid` solo cuando utilice filtros o algoritmos que dependan de datos históricos del usuario, como “Recently Viewed” o “Recommended for You”.
`shop_id`	String	True	Store Key. Encuéntrela en Recommendations > Settings > Store settings en la aplicación Kameleoon. Contacte con su Customer Success Manager para obtener la clave si es necesario.
`type`	String	True	Especifica el tipo de búsqueda: `instant_search` o `full_search`.
`search_query`	String	True	Consulta de búsqueda actual.
`locations`	List	Opcional	Lista separada por comas de IDs de ubicaciones.

Parámetros de consulta adicionales (solo búsqueda completa)

Utilice estos parámetros adicionales con solicitudes de búsqueda completa (type=full_search).

Parámetro	Tipo	Obligatorio	Descripción
`limit`	Integer	Opcional	Número máximo de resultados que devuelve la API.
`offset`	Integer	Opcional	Desplazamiento del resultado.
`category_limit`	Integer	Opcional	Número máximo de categorías para el filtro de la barra lateral.
`categories`	List	Opcional	Lista separada por comas de categorías para filtrar.
`extended`	Integer o vacío	Opcional	Añade información extendida para los resultados de producto. Valores admitidos: `1` o vacío. Si es `1`, la API devuelve toda la información del producto. Si está vacío, la API devuelve solo los IDs de los productos. Kameleoon recomienda establecer esto en `1` para la búsqueda completa.
`sort_by`	String	Opcional	Parámetro de ordenación. Valores admitidos: `popular`, `price`, `discount`, `sales_rate`, `date`.
`order`	String	Opcional	Dirección de ordenación: `asc` (ascendente) o `desc` (descendente). El valor por defecto es `desc`.
`brands`	List	Opcional	Lista separada por comas de marcas para filtrar.
`filters`	String	Opcional	Cadena JSON escapada con parámetros de filtro. Ejemplo: `{"bluetooth":["yes"],"offers":["15% cashback"],"weight":["1.6"]}`
`price_min`	Integer	Opcional	Precio mínimo.
`price_max`	Integer	Opcional	Precio máximo.
`colors`	List	Opcional	Lista separada por comas de colores.
`exclude`	List	Opcional	Lista separada por comas de IDs de productos a excluir de los resultados de búsqueda.

Respuesta (búsqueda instantánea)

Nombre	Tipo	Descripción
`search_query`	string	Consulta de búsqueda.
`categories`	array	Información de categoría. Cada objeto contiene estas propiedades: `id` – ID de la categoría (string) `name` – nombre de la categoría (string) `url` – URL de la categoría (string) `count` – número de productos en la categoría (number)
`filters`	array	Información de filtro. Cada objeto contiene estas propiedades: `filter` – Objeto filtro que contiene estas propiedades: `count` – total de productos que coinciden con estos parámetros (number) `values` – array de objetos de valor que contienen estas propiedades: `value` – etiqueta del valor (string) `count` – número de productos con este parámetro (number)
`html`	string	Código HTML para el bloque de producto. Personalice la plantilla en la cuenta personal de Kameleoon.
`price_range`	object	Precios mínimo y máximo del producto. Contiene estas propiedades: `min` – precio mínimo (number) `max` – precio máximo (number)
`products`	array	Información de producto. Cada objeto contiene estas propiedades: `description` – descripción del producto (string) `url` – URL absoluta del producto (string) `url_handle` – URL relativa del producto (string) `picture` – URL de la imagen del producto en el almacenamiento de Kameleoon (string) `name` – nombre del producto (string) `price` – precio del producto (integer) `price_full` – precio del producto (float) `price_formatted` – precio del producto con moneda (string) `price_full_formatted` – precio del producto formateado con moneda (string) `image_url` - URL absoluta de la imagen del producto en el almacenamiento de Kameleoon (string) `image_url_handle` - URL relativa de la imagen del producto en el almacenamiento de Kameleoon (string) `image_url_resized` - array de URLs de imágenes redimensionadas `currency` – moneda del producto (string) `id` – ID del producto (string) `old_price` – precio antiguo del producto (string, por defecto es 0) `old_price_full` – precio antiguo del producto (float) `old_price_formatted` – precio antiguo del producto con moneda (string) `old_price_full_formatted` – precio antiguo del producto formateado con moneda (string) Propiedades adicionales si incluye `extended` en la solicitud: `id` – ID de la categoría (string) `name` – nombre de la categoría (string) `parent_id` – ID de la categoría padre (string) `url` - URL de la categoría `category_ids` - IDs de las categorías del producto (array)
`search_query_redirects`	array	Información de redirección. Cada objeto contiene estas propiedades: `query` – consulta de búsqueda (string) `redirect_link` – URL para redirección (string) `deep_link` – URL para aplicaciones móviles (string)
`products_total`	number	Número total de productos.

Respuesta (búsqueda completa)

Nombre	Tipo	Descripción
`brands`	array	Información de marca. Cada objeto contiene estas propiedades: `name` – nombre de la marca (string) `picture` – URL de la imagen de la marca (string)
`categories`	array	Información de categoría. Cada objeto contiene estas propiedades: `alias` – alias de la categoría (string) `id` – ID de la categoría (string) `name` – nombre de la categoría (string) `parent` – ID de la categoría padre (string) `url` – URL de la categoría (string)
`filters`	array	Información de filtro. Cada objeto contiene estas propiedades: `filter` – Objeto filtro que contiene estas propiedades: `count` – total de productos que coinciden con estos parámetros (number) `values` – objetos de valor que contienen `value` (string) y `count` (number)
`html`	string	Código HTML para el bloque de producto. Personalice la plantilla en la cuenta personal de Kameleoon.
`price_range`	object	Precios mínimo y máximo del producto. Contiene estas propiedades: `min` – precio mínimo (number) `max` – precio máximo (number)
`products`	array	Información de producto. Cada objeto contiene estas propiedades: `brand` – marca del producto (string) `currency` – moneda del producto (string) `id` – ID del producto (string) `is_new` – propiedad del producto (boolean, por defecto es null) `name` – nombre del producto (string) `old_price` – precio antiguo del producto (string, por defecto es 0) `picture` – URL de la imagen del producto en el almacenamiento de Kameleoon (string) `price` – precio del producto (number) `price_formatted` – precio del producto con moneda (string) `url` – URL del producto (string) Propiedades adicionales si incluye `extended` en la solicitud: `barcode` – código de barras del producto (string) `categories` – categorías del producto (array) que contiene `id`, `name` y `parent` ID. `params` – información de parámetro. Cada objeto contiene `key` (string) y `values` (array).
`products_total`	number	Conteo total de productos.
`search_query`	string	Consulta de búsqueda.

Parámetros de consulta

did

string

requerido

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

requerido

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

requerido

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

type

enum<string>

requerido

Specifies the search type.

Opciones disponibles:

instant_search,

full_search

search_query

string

requerido

Current search query.

locations

string[]

Comma-separated list of location IDs.

limit

integer

Maximum number of results the API returns. Full search only.

offset

integer

Result offset. Full search only.

category_limit

integer

Maximum number of categories for the sidebar filter. Full search only.

Respuesta

200 - application/json

Matching products for the search query. Verified against a live response on 2026-09-24. The exact response shape depends on type: instant search additionally returns queries, and full search additionally returns brands, price_ranges, price_median, and (with extended=1) industrial_filters.

Response shape verified against a live response on 2026-09-24. Fields kept from the original reference but not observed in that sample (search_query_redirects) may still appear conditionally. queries was observed for instant search; industrial_filters was observed for full search with extended=1.

search_query

string

The search query, as processed by Kameleoon.

search_query_original

string

The search query exactly as submitted.

collections

object[]

Matching product collections, if any.

APIs

​Parámetros de consulta

​Parámetros de consulta adicionales (solo búsqueda completa)

​Respuesta (búsqueda instantánea)

​Respuesta (búsqueda completa)

Parámetros de consulta

Respuesta

Parámetros de consulta

Parámetros de consulta adicionales (solo búsqueda completa)

Respuesta (búsqueda instantánea)

Respuesta (búsqueda completa)