Skip to main content
GET
Retrieve collection
El servicio proporciona acceso al endpoint de colección de productos.
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

Respuesta

Lista de campos para el array de objetos products

Lista de propiedades para el array categories

Parámetros de ruta

collection_id
string
requerido

The ID of the product collection to retrieve.

Parámetros de consulta

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.

did
string

Device ID. You can find this ID in the cookie KameleoonProducts_device_id, retrieved from the back end before calling this endpoint.

sid
string

Temporary user session ID. Get this ID from the KameleoonProducts_session_code cookie. Retrieve it from the backend before calling this endpoint. Not independently verified live for this endpoint; added for consistency with the documented query-parameter table.

location
string

User's location.

external_id
string

Unique identifier associated with a user in your system or CRM. To ensure accurate matching with the Kameleoon VisitorCode, store this ID as Kameleoon Custom Data with "Use this custom data as a unique identifier for cross-device matching" enabled.

Respuesta

200 - application/json

The collection's products and HTML template.

products
object[]

Information about the products in the collection.

html
string

The HTML template selected when the collection was created.