Récupérer une collection
Recommander
Récupérer une collection
Récupérez une collection de produits configurée et son template HTML depuis la Product Recommendation API de Kameleoon.
GET
Récupérer une collection
Le service fournit l’accès à l’endpoint de collection de produits.
Liste des champs pour le tableau d’objets
Liste des propriétés pour le tableau
Requête HTTP
Vous pouvez trouver le
collection_id du produit dans la section Product Collections du dashboard. Vos collections configurées y sont listées avec leurs numéros d’ID.Paramètres de requête
| Paramètre | Type | Requis | Description |
|---|---|---|---|
shop_id | String | True | Votre Store Key. Vous pouvez la trouver dans Recommendations > Settings > Store settings dans l’application Kameleoon. Vous pouvez également contacter votre Customer Success Manager pour obtenir la clé. |
did | String | False | Device ID. Vous pouvez trouver cet ID dans le cookie KameleoonProducts_device_id, que vous pouvez récupérer depuis le back-end avant d’appeler cet endpoint. |
location | String | False | Lieu de l’utilisateur. |
external_id | String | False | C’est un identifiant unique associé à un utilisateur dans votre système ou CRM. (Pour assurer une correspondance précise avec le VisitorCode Kameleoon, l’ID doit d’abord être stocké en tant que Kameleoon Custom Data. Lors de la configuration de ce custom data, assurez-vous d’activer l’option Use this custom data as a unique identifier for cross-device matching pour garantir que l’ID est utilisé pour relier les activités utilisateur entre les deux systèmes.). |
Réponse de l’API
| Nom | Type | Description |
|---|---|---|
products | Array of objects | Tableau avec des informations sur les produits. Chaque objet possède les propriétés suivantes. |
html | String | Le template HTML sélectionné lors de la création de la collection |
Liste des champs pour le tableau d’objets products
| Propriété | Description |
|---|---|
name | Nom du produit |
url | URL complète vers la page du produit |
category_ids | Liste des IDs de catégories associées |
barcode | Code-barres du produit ou identifiant unique |
vendor_code | Code du vendeur ou de la marque |
brand | Nom de la marque |
leftovers | Indique le type de stock (par exemple, “lot”, “single”, etc.) |
rating | Note du produit |
fashion_feature | Caractéristique mode ou public cible (par exemple, child, woman) |
fashion_wear_type | Type d’article de mode (par exemple, shoe, clothing) |
fashion_original_sizes | Tailles d’origine disponibles |
picture | URL de l’image par défaut |
categories | Catégories de produit (tableau). Possède les propriétés suivantes. |
price_formatted | Prix du produit formaté en chaîne (par exemple, ”$ 70”) |
price_full_formatted | Prix complet du produit formaté en chaîne (par exemple, ”$ 70.00”) |
price | Prix du produit en tant que nombre |
price_full | Prix complet du produit en tant que nombre |
image_url | URL de l’image principale |
image_url_handle | Chemin relatif vers l’image principale |
image_url_resized | Objet avec les URLs des images redimensionnées par taille |
url_handle | Chemin relatif vers la page du produit |
currency | Symbole de la devise (par exemple, ”$“) |
_id | Identifiant unique interne |
id | ID du produit (souvent identique au code-barres) |
stock_quantity | Quantité en stock disponible |
fashion_colors | Couleur(s) disponibles pour le produit |
params | Liste de paires clé/valeur représentant les attributs du produit (par exemple, taille, couleur) |
group_id | ID du groupe auquel le produit appartient |
Liste des propriétés pour le tableau categories
| Propriété | Description |
|---|---|
id | ID de la catégorie |
parent_id | (Optionnel) ID de la catégorie parente (le cas échéant) |
url | URL complète de la catégorie |
name | Nom de la catégorie |
level | Niveau de la catégorie (par exemple, “1” = parent, “2” = sous-catégorie) |
url_handle | Chemin URL relatif vers la catégorie |