Passer au contenu principal
GET
/
endpoint
Récupérer les résultats de recherche
curl --request GET \
  --url https://api.example.com/endpoint
Le service Kameleoon Search propose deux types de recherche :
  • Instant (typeahead) search : affiche et met à jour les résultats au fur et à mesure que les utilisateurs saisissent leurs requêtes de recherche.
  • Full search : renvoie des résultats de recherche complets et filtrés après que l’utilisateur a soumis une requête de recherche.
Les deux options utilisent le même endpoint. Utilisez le paramètre type pour spécifier le type de recherche.

​
Requête

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

​
Paramètres de requête

Ces paramètres de requête s’appliquent à la fois à la full search et à l’instant search. Utilisez les paramètres supplémentaires uniquement avec la full search.
ParamètreTypeRequisDescription
didStringTrueDevice ID. Obtenez cet ID à partir du cookie KameleoonProducts_device_id. Récupérez-le depuis le backend avant d’appeler cet endpoint. Ne fournissez did que lorsque vous utilisez des filtres ou des algorithmes qui reposent sur des données historiques de l’appareil, comme “Recently Viewed” ou “Recommended for You.”
sidStringTrueID de session utilisateur temporaire. Obtenez cet ID à partir du cookie KameleoonProducts_session_code. Récupérez-le depuis le backend avant d’appeler cet endpoint. Ne fournissez sid que lorsque vous utilisez des filtres ou des algorithmes qui reposent sur des données historiques de l’utilisateur, comme “Recently Viewed” ou “Recommended for You.”
shop_idStringTrueStore Key. Trouvez-le dans Recommendations > Settings > Store settings dans l’application Kameleoon. Contactez votre Customer Success Manager pour obtenir la clé si nécessaire.
typeStringTrueSpécifie le type de recherche : instant_search ou full_search.
search_queryStringTrueRequête de recherche actuelle.
locationsListOptionnelListe séparée par des virgules des IDs de lieux.

​
Paramètres de requête supplémentaires (full search uniquement)

Utilisez ces paramètres supplémentaires avec les requêtes full search (type=full_search).
ParamètreTypeRequisDescription
limitIntegerOptionnelNombre maximum de résultats que l’API renvoie.
offsetIntegerOptionnelDécalage des résultats.
category_limitIntegerOptionnelNombre maximum de catégories pour le filtre latéral.
categoriesListOptionnelListe séparée par des virgules des catégories pour le filtrage.
extendedInteger or emptyOptionnelAjoute des informations étendues pour les résultats des produits. Valeurs prises en charge : 1 ou vide. Si 1, l’API renvoie toutes les informations sur le produit. Si vide, l’API ne renvoie que les IDs des produits. Kameleoon recommande de définir cette valeur sur 1 pour la full search.
sort_byStringOptionnelParamètre de tri. Valeurs prises en charge : popular, price, discount, sales_rate, date.
orderStringOptionnelDirection du tri : asc (ascendant) ou desc (descendant). La valeur par défaut est desc.
brandsListOptionnelListe séparée par des virgules des marques pour le filtrage.
filtersStringOptionnelChaîne JSON échappée avec des paramètres de filtre. Exemple : {"bluetooth":["yes"],"offers":["15% cashback"],"weight":["1.6"]}
price_minIntegerOptionnelPrix minimum.
price_maxIntegerOptionnelPrix maximum.
colorsIntegerOptionnelListe séparée par des virgules des couleurs.
excludeIntegerOptionnelListe séparée par des virgules des IDs de produits à exclure des résultats de recherche.
NomTypeDescription
search_querystringRequête de recherche.
categoriesarrayInformations sur les catégories. Chaque objet contient ces propriétés :
  • id – ID de la catégorie (string)
  • name – nom de la catégorie (string)
  • url – URL de la catégorie (string)
  • count – nombre de produits dans la catégorie (number)
filtersarrayInformations sur les filtres. Chaque objet contient ces propriétés :
  • filter – Objet filtre contenant ces propriétés :
  • count – nombre total de produits correspondant à ces paramètres (number)
  • values – tableau d’objets de valeur contenant ces propriétés :
  • value – libellé de la valeur (string)
  • count – nombre de produits avec ce paramètre (number)
htmlstringCode HTML pour le bloc de produits. Personnalisez le template dans le compte personnel Kameleoon.
price_rangeobjectPrix minimum et maximum des produits. Contient ces propriétés :
  • min – prix minimum (number)
  • max – prix maximum (number)
productsarrayInformations sur les produits. Chaque objet contient ces propriétés :
  • description – description du produit (string)
  • url – URL absolue du produit (string)
  • url_handle – URL relative du produit (string)
  • picture – URL de l’image du produit dans le stockage Kameleoon (string)
  • name – nom du produit (string)
  • price – prix du produit (integer)
  • price_full – prix du produit (float)
  • price_formatted – prix du produit avec devise (string)
  • price_full_formatted – prix du produit formaté avec devise (string)
  • image_url - URL absolue de l’image du produit dans le stockage Kameleoon (string)
  • image_url_handle - URL relative de l’image du produit dans le stockage Kameleoon (string)
  • image_url_resized - tableau d’URLs d’images redimensionnées
  • currency – devise du produit (string)
  • id – ID du produit (string)
  • old_price – ancien prix du produit (integer, par défaut 0)
  • old_price_full – ancien prix du produit (float)
  • old_price_formatted – ancien prix du produit avec devise (string)
  • old_price_full_formatted – ancien prix du produit formaté avec devise (string)
  • Propriétés supplémentaires si vous incluez extended dans la requête :
    • id – ID de la catégorie (string)
    • name – nom de la catégorie (string)
    • parent_id – ID de la catégorie parente (string)
    • url - URL de la catégorie
    • category_ids - IDs des catégories du produit (array)
search_query_redirectsarrayInformations de redirection. Chaque objet contient ces propriétés :
  • query – requête de recherche (string)
  • redirect_link – URL pour la redirection (string)
  • deep_link – URL pour les applications mobiles (string)
products_totalnumberNombre total de produits.
NomTypeDescription
brandsarrayInformations sur les marques. Chaque objet contient ces propriétés :
  • name – nom de la marque (string)
  • picture – URL de l’image de la marque (string)
categoriesarrayInformations sur les catégories. Chaque objet contient ces propriétés :
  • alias – alias de la catégorie (string)
  • id – ID de la catégorie (string)
  • name – nom de la catégorie (string)
  • parent – ID de la catégorie parente (string)
  • url – URL de la catégorie (string)
filtersarrayInformations sur les filtres. Chaque objet contient ces propriétés :
  • filter – Objet filtre contenant ces propriétés :
    • count – nombre total de produits correspondant à ces paramètres (number)
    • values – objets de valeur contenant value (string) et count (number)
htmlstringCode HTML pour le bloc de produits. Personnalisez le template dans le compte personnel Kameleoon.
price_rangeobjectPrix minimum et maximum des produits. Contient ces propriétés :
  • min – prix minimum (number)
  • max – prix maximum (number)
productsarrayInformations sur les produits. Chaque objet contient ces propriétés :
  • brand – marque du produit (string)
  • currency – devise du produit (string)
  • id – ID du produit (string)
  • is_new – propriété du produit (boolean, par défaut null)
  • name – nom du produit (string)
  • old_price – ancien prix du produit (string, par défaut 0)
  • picture – URL de l’image du produit dans le stockage Kameleoon (string)
  • price – prix du produit (number)
  • price_formatted – prix du produit avec devise (string)
  • url – URL du produit (string)
  • Propriétés supplémentaires si vous incluez extended dans la requête :
    • barcode – code-barres du produit (string)
  • categories – catégories du produit (array) contenant id, name et l’ID parent.
  • params – informations sur les paramètres. Chaque objet contient key (string) et values (array).
products_totalnumberNombre total de produits.
search_querystringRequête de recherche.