Saltar al contenido principal
GET
/
endpoint
Recuperar resultados de búsqueda
curl --request GET \
  --url https://api.example.com/endpoint
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.

​
Solicitud

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

​
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ámetroTipoObligatorioDescripción
didStringTrueDevice 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”.
sidStringTrueID 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_idStringTrueStore 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.
typeStringTrueEspecifica el tipo de búsqueda: instant_search o full_search.
search_queryStringTrueConsulta de búsqueda actual.
locationsListOpcionalLista 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ámetroTipoObligatorioDescripción
limitIntegerOpcionalNúmero máximo de resultados que devuelve la API.
offsetIntegerOpcionalDesplazamiento del resultado.
category_limitIntegerOpcionalNúmero máximo de categorías para el filtro de la barra lateral.
categoriesListOpcionalLista separada por comas de categorías para filtrar.
extendedInteger o vacíoOpcionalAñ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_byStringOpcionalParámetro de ordenación. Valores admitidos: popular, price, discount, sales_rate, date.
orderStringOpcionalDirección de ordenación: asc (ascendente) o desc (descendente). El valor por defecto es desc.
brandsListOpcionalLista separada por comas de marcas para filtrar.
filtersStringOpcionalCadena JSON escapada con parámetros de filtro. Ejemplo: {"bluetooth":["yes"],"offers":["15% cashback"],"weight":["1.6"]}
price_minIntegerOpcionalPrecio mínimo.
price_maxIntegerOpcionalPrecio máximo.
colorsIntegerOpcionalLista separada por comas de colores.
excludeIntegerOpcionalLista separada por comas de IDs de productos a excluir de los resultados de búsqueda.

​
Respuesta (búsqueda instantánea)

NombreTipoDescripción
search_querystringConsulta de búsqueda.
categoriesarrayInformació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)
filtersarrayInformació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)
htmlstringCódigo HTML para el bloque de producto. Personalice la plantilla en la cuenta personal de Kameleoon.
price_rangeobjectPrecios mínimo y máximo del producto. Contiene estas propiedades:
  • min – precio mínimo (number)
  • max – precio máximo (number)
productsarrayInformació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 (integer, 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_redirectsarrayInformació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_totalnumberNúmero total de productos.

​
Respuesta (búsqueda completa)

NombreTipoDescripción
brandsarrayInformación de marca. Cada objeto contiene estas propiedades:
  • name – nombre de la marca (string)
  • picture – URL de la imagen de la marca (string)
categoriesarrayInformació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)
filtersarrayInformació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)
htmlstringCódigo HTML para el bloque de producto. Personalice la plantilla en la cuenta personal de Kameleoon.
price_rangeobjectPrecios mínimo y máximo del producto. Contiene estas propiedades:
  • min – precio mínimo (number)
  • max – precio máximo (number)
productsarrayInformació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_totalnumberConteo total de productos.
search_querystringConsulta de búsqueda.