Recuperar colección
Recomendar
Recuperar colección
Recupere una colección de productos configurada y su plantilla HTML desde la Product Recommendation API de Kameleoon.
GET
Recuperar colección
El servicio proporciona acceso al endpoint de colección de productos.
Lista de campos para el array de objetos
Lista de propiedades para el array
Solicitud HTTP
Puede encontrar el
collection_id del producto en la sección Product Collections del dashboard. Sus colecciones configuradas se listan allí junto con sus números de ID.Parámetros de consulta
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
shop_id | String | True | Su Store Key. Puede encontrarla en Recommendations > Settings > Store settings en la aplicación Kameleoon. También puede contactar con su Customer Success Manager para obtener la clave. |
did | String | False | Device ID. Puede encontrar este ID en la cookie KameleoonProducts_device_id, que puede recuperar desde el back-end antes de llamar a este endpoint. |
location | String | False | Ubicación del usuario. |
external_id | String | False | Es un identificador único asociado a un usuario en su sistema o CRM. (Para garantizar una correspondencia precisa con el VisitorCode de Kameleoon, el ID debe almacenarse primero como un custom data de Kameleoon. Al configurar este custom data, asegúrese de activar la opción Use this custom data as a unique identifier for cross-device matching para garantizar que el ID se utiliza para vincular las actividades del usuario en ambos sistemas.). |
Respuesta de la API
| Nombre | Tipo | Descripción |
|---|---|---|
products | Array de objetos | Array con información sobre los productos. Cada objeto tiene las siguientes propiedades. |
html | String | La plantilla HTML seleccionada cuando se creó la colección |
Lista de campos para el array de objetos products
| Propiedad | Descripción |
|---|---|
name | Nombre del producto |
url | URL completa de la página del producto |
category_ids | Lista de IDs de categorías asociadas |
barcode | Código de barras o identificador único del producto |
vendor_code | Código del proveedor o marca |
brand | Nombre de la marca |
leftovers | Indica el tipo de stock (por ejemplo, “lot”, “single”, etc.) |
rating | Valoración del producto |
fashion_feature | Característica de moda o audiencia objetivo (por ejemplo, child, woman) |
fashion_wear_type | Tipo de artículo de moda (por ejemplo, shoe, clothing) |
fashion_original_sizes | Tamaños originales disponibles |
picture | URL de imagen por defecto |
categories | Categorías del producto (array). Tiene las siguientes propiedades. |
price_formatted | Precio del producto formateado como cadena (por ejemplo, ”$ 70”) |
price_full_formatted | Precio completo del producto formateado como cadena (por ejemplo, ”$ 70.00”) |
price | Precio del producto como número |
price_full | Precio completo del producto como número |
image_url | URL de la imagen principal |
image_url_handle | Ruta relativa de la imagen principal |
image_url_resized | Objeto con URLs de imágenes redimensionadas por tamaño |
url_handle | Ruta relativa a la página del producto |
currency | Símbolo de la moneda (por ejemplo, ”$“) |
_id | Identificador único interno |
id | ID del producto (a menudo el mismo que el código de barras) |
stock_quantity | Cantidad de stock disponible |
fashion_colors | Color(es) disponible(s) para el producto |
params | Lista de pares clave/valor que representan atributos del producto (por ejemplo, tamaño, color) |
group_id | ID del grupo al que pertenece el producto |
Lista de propiedades para el array categories
| Propiedad | Descripción |
|---|---|
id | ID de la categoría |
parent_id | (Opcional) ID de la categoría padre (si procede) |
url | URL completa de la categoría |
name | Nombre de la categoría |
level | Nivel de la categoría (por ejemplo, “1” = padre, “2” = subcategoría) |
url_handle | Ruta URL relativa a la categoría |