> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kameleoon.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Récupérer les résultats de recherche

> Interrogez le service Kameleoon Search pour récupérer des résultats de recherche de produits instantanés ou complets en fonction de la saisie de l'utilisateur.

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](#paramètres-de-requête-supplémentaires-full-search-uniquement) uniquement avec la full search.

| Paramètre      | Type   | Requis    | Description                                                                                                                                                                                                                                                                                                                                                      |
| :------------- | :----- | :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `did`          | String | True      | Device 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."                                  |
| `sid`          | String | True      | ID 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_id`      | String | True      | Store Key. Trouvez-le dans **Recommendations** > **Settings** > **Store settings** dans l'application Kameleoon. Contactez votre Customer Success Manager pour obtenir la clé si nécessaire.                                                                                                                                                                     |
| `type`         | String | True      | Spécifie le type de recherche : `instant_search` ou `full_search`.                                                                                                                                                                                                                                                                                               |
| `search_query` | String | True      | Requête de recherche actuelle.                                                                                                                                                                                                                                                                                                                                   |
| `locations`    | List   | Optionnel | Liste 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ètre        | Type             | Requis    | Description                                                                                                                                                                                                                                                                                           |
| :--------------- | :--------------- | :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `limit`          | Integer          | Optionnel | Nombre maximum de résultats que l'API renvoie.                                                                                                                                                                                                                                                        |
| `offset`         | Integer          | Optionnel | Décalage des résultats.                                                                                                                                                                                                                                                                               |
| `category_limit` | Integer          | Optionnel | Nombre maximum de catégories pour le filtre latéral.                                                                                                                                                                                                                                                  |
| `categories`     | List             | Optionnel | Liste séparée par des virgules des catégories pour le filtrage.                                                                                                                                                                                                                                       |
| `extended`       | Integer or empty | Optionnel | Ajoute 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_by`        | String           | Optionnel | Paramètre de tri. Valeurs prises en charge : `popular`, `price`, `discount`, `sales_rate`, `date`.                                                                                                                                                                                                    |
| `order`          | String           | Optionnel | Direction du tri : `asc` (ascendant) ou `desc` (descendant). La valeur par défaut est `desc`.                                                                                                                                                                                                         |
| `brands`         | List             | Optionnel | Liste séparée par des virgules des marques pour le filtrage.                                                                                                                                                                                                                                          |
| `filters`        | String           | Optionnel | Chaîne JSON échappée avec des paramètres de filtre. Exemple : `{"bluetooth":["yes"],"offers":["15% cashback"],"weight":["1.6"]}`                                                                                                                                                                      |
| `price_min`      | Integer          | Optionnel | Prix minimum.                                                                                                                                                                                                                                                                                         |
| `price_max`      | Integer          | Optionnel | Prix maximum.                                                                                                                                                                                                                                                                                         |
| `colors`         | Integer          | Optionnel | Liste séparée par des virgules des couleurs.                                                                                                                                                                                                                                                          |
| `exclude`        | Integer          | Optionnel | Liste séparée par des virgules des IDs de produits à exclure des résultats de recherche.                                                                                                                                                                                                              |

### Réponse (instant search)

| Nom                      | Type   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| :----------------------- | :----- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `search_query`           | string | Requête de recherche.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `categories`             | array  | Informations sur les catégories. Chaque objet contient ces propriétés :<ul><li>`id` – ID de la catégorie (string)</li><li>`name` – nom de la catégorie (string)</li><li>`url` – URL de la catégorie (string)</li><li>`count` – nombre de produits dans la catégorie (number)</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `filters`                | array  | Informations sur les filtres. Chaque objet contient ces propriétés : <ul><li>`filter` – Objet filtre contenant ces propriétés :</li><li>`count` – nombre total de produits correspondant à ces paramètres (number)</li><li>`values` – tableau d'objets de valeur contenant ces propriétés :</li><li>`value` – libellé de la valeur (string)</li><li>`count` – nombre de produits avec ce paramètre (number)</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `html`                   | string | Code HTML pour le bloc de produits. Personnalisez le template dans le compte personnel Kameleoon.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `price_range`            | object | Prix minimum et maximum des produits. Contient ces propriétés :<ul><li>`min` – prix minimum (number)</li><li>`max` – prix maximum (number)</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `products`               | array  | Informations sur les produits. Chaque objet contient ces propriétés :<ul><li>`description` – description du produit (string)</li><li>`url` – URL absolue du produit (string)</li><li>`url_handle` – URL relative du produit (string)</li><li>`picture` – URL de l'image du produit dans le stockage Kameleoon (string)</li><li>`name` – nom du produit (string)</li><li>`price` – prix du produit (integer)</li><li>`price_full` – prix du produit (float)</li><li>`price_formatted` – prix du produit avec devise (string)</li><li>`price_full_formatted` – prix du produit formaté avec devise (string)</li><li>`image_url` - URL absolue de l'image du produit dans le stockage Kameleoon (string)</li><li>`image_url_handle` - URL relative de l'image du produit dans le stockage Kameleoon (string)</li><li>`image_url_resized` - tableau d'URLs d'images redimensionnées</li><li>`currency` – devise du produit (string)</li><li>`id` – ID du produit (string)</li><li>`old_price` – ancien prix du produit (integer, par défaut 0)</li><li>`old_price_full` – ancien prix du produit (float)</li><li>`old_price_formatted` – ancien prix du produit avec devise (string)</li><li>`old_price_full_formatted` – ancien prix du produit formaté avec devise (string)</li><li>Propriétés supplémentaires si vous incluez `extended` dans la requête :<ul><li>`id` – ID de la catégorie (string)</li><li>`name` – nom de la catégorie (string)</li><li>`parent_id` – ID de la catégorie parente (string)</li><li>`url` - URL de la catégorie</li><li>`category_ids` - IDs des catégories du produit (array)</li></ul></li></ul> |
| `search_query_redirects` | array  | Informations de redirection. Chaque objet contient ces propriétés :<ul><li>`query` – requête de recherche (string)</li><li>`redirect_link` – URL pour la redirection (string)</li><li>`deep_link` – URL pour les applications mobiles (string)</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `products_total`         | number | Nombre total de produits.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |

### Réponse (full search)

| Nom              | Type   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| :--------------- | :----- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `brands`         | array  | Informations sur les marques. Chaque objet contient ces propriétés :<ul><li>`name` – nom de la marque (string)</li><li>`picture` – URL de l'image de la marque (string)</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `categories`     | array  | Informations sur les catégories. Chaque objet contient ces propriétés :<ul><li>`alias` – alias de la catégorie (string)</li><li>`id` – ID de la catégorie (string)</li><li>`name` – nom de la catégorie (string)</li><li>`parent` – ID de la catégorie parente (string)</li><li>`url` – URL de la catégorie (string)</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `filters`        | array  | Informations sur les filtres. Chaque objet contient ces propriétés :<ul><li>`filter` – Objet filtre contenant ces propriétés :<ul><li>`count` – nombre total de produits correspondant à ces paramètres (number)</li><li>`values` – objets de valeur contenant `value` (string) et `count` (number)</li></ul></li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `html`           | string | Code HTML pour le bloc de produits. Personnalisez le template dans le compte personnel Kameleoon.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `price_range`    | object | Prix minimum et maximum des produits. Contient ces propriétés :<ul><li>`min` – prix minimum (number)</li><li>`max` – prix maximum (number)</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `products`       | array  | Informations sur les produits. Chaque objet contient ces propriétés :<ul><li>`brand` – marque du produit (string)</li><li>`currency` – devise du produit (string)</li><li>`id` – ID du produit (string)</li><li>`is_new` – propriété du produit (boolean, par défaut null)</li><li>`name` – nom du produit (string)</li><li>`old_price` – ancien prix du produit (string, par défaut 0)</li><li>`picture` – URL de l'image du produit dans le stockage Kameleoon (string)</li><li>`price` – prix du produit (number)</li><li>`price_formatted` – prix du produit avec devise (string)</li><li>`url` – URL du produit (string)</li><li>Propriétés supplémentaires si vous incluez `extended` dans la requête :<ul><li>`barcode` – code-barres du produit (string)</li></ul></li><li>`categories` – catégories du produit (array) contenant `id`, `name` et l'ID `parent`.</li><li>`params` – informations sur les paramètres. Chaque objet contient `key` (string) et `values` (array).</li></ul> |
| `products_total` | number | Nombre total de produits.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `search_query`   | string | Requête de recherche.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |