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

# Lister les résultats shopping

> Listez les observations shopping extraites des réponses enregistrées.

Renvoie les observations shopping extraites des réponses enregistrées. Le détail des produits, les notes, les avis et les options d’achat peuvent valoir `null` ou être vides lorsqu’ils n’ont pas été capturés.

<ParamField header="Authorization" type="string" required>
  Jeton bearer. Exemple : `Bearer qw-api-xxx`
</ParamField>

```http theme={null}
GET /api/v1/brands/{brandId}/shopping
```

## Paramètres de chemin

<ParamField path="brandId" type="string" required>
  L’identifiant unique de la marque
</ParamField>

## Paramètres de requête

<ParamField query="period" type="number">
  Nombre de jours à inclure. Sans valeur, toutes les données sont renvoyées.
</ParamField>

<ParamField query="startDate" type="string">
  Date de début au format `YYYY-MM-DD`. Fournissez-la avec `endDate` ; une borne seule est actuellement ignorée. Choisissez soit `period`, soit la paire de dates complète.
</ParamField>

<ParamField query="endDate" type="string">
  Date de fin au format `YYYY-MM-DD`. Fournissez-la avec `startDate` ; une borne seule est actuellement ignorée. Ne combinez pas la paire de dates complète avec `period`.
</ParamField>

<ParamField query="provider" type="string">
  Filtre par un ou plusieurs alias de fournisseurs ou identifiants de modèles, séparés par des virgules.
</ParamField>

<ParamField query="limit" type="number" default="50">
  Nombre maximal de produits renvoyés (maximum : 100)
</ParamField>

<ParamField query="offset" type="number" default="0">
  Nombre de résultats à ignorer pour la pagination
</ParamField>

<ParamField query="sort" type="string" default="createdAt">
  Champ de tri : `createdAt`, `rating`, `reviews`, `productName`
</ParamField>

<ParamField query="order" type="string" default="desc">
  Ordre de tri : `asc` ou `desc`
</ParamField>

## Réponse

<ResponseField name="success" type="boolean">
  Indique si la requête a réussi
</ResponseField>

<ResponseField name="pagination" type="object">
  <Expandable title="Informations de pagination">
    <ResponseField name="total" type="number">Nombre total de produits correspondant aux filtres</ResponseField>
    <ResponseField name="count" type="number">Nombre de produits dans cette réponse</ResponseField>
    <ResponseField name="limit" type="number">Nombre maximal d’éléments par page</ResponseField>
    <ResponseField name="offset" type="number">Nombre d’éléments ignorés</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="shopping" type="array">
  <Expandable title="Objet shopping">
    <ResponseField name="id" type="string">Identifiant de l’observation shopping</ResponseField>
    <ResponseField name="productName" type="string">Nom du produit</ResponseField>
    <ResponseField name="description" type="string">Description du produit</ResponseField>
    <ResponseField name="image" type="string">URL de l’image du produit</ResponseField>
    <ResponseField name="rating" type="number">Note du produit (0 à 5)</ResponseField>
    <ResponseField name="reviews" type="number">Nombre d’avis</ResponseField>
    <ResponseField name="options" type="array">Options d’achat avec prix et vendeurs</ResponseField>
    <ResponseField name="prompt" type="string">Prompt associé à l’observation enregistrée</ResponseField>
    <ResponseField name="createdAt" type="string">Horodatage ISO 8601</ResponseField>
  </Expandable>
</ResponseField>

## Exemple de requête

```bash theme={null}
curl -X GET "https://www.qwairy.co/api/v1/brands/cm1234567890abcdef/shopping?limit=10" \
  -H "Authorization: Bearer qw-api-your-token-here"
```

## Exemple de réponse

```json theme={null}
{
  "success": true,
  "pagination": {
    "total": 85,
    "count": 2,
    "limit": 10,
    "offset": 0
  },
  "shopping": [
    {
      "id": "shop1",
      "productName": "Northstar Analytics Pro",
      "description": "Synthetic product description",
      "image": "https://assets.northstar.example/product-image.jpg",
      "rating": 4.5,
      "reviews": 1250,
      "options": [
        {
          "price": "$99/month",
          "currency": "USD",
          "websiteName": "Northstar Labs",
          "websiteUrl": "https://northstar.example/pricing"
        }
      ],
      "prompt": "What is the best CRM software for enterprise?",
      "createdAt": "2026-07-15T10:30:00Z"
    },
    {
      "id": "shop2",
      "productName": "Orbit Insights",
      "description": "Synthetic analytics product",
      "image": null,
      "rating": 4.2,
      "reviews": 890,
      "options": [],
      "prompt": "Compare top analytics platforms",
      "createdAt": "2026-07-14T15:45:00Z"
    }
  ]
}
```

## Erreurs

| Statut | Code | Description |
| - | - | - |
| 400 | `INVALID_PARAMETER` | Valeur de filtre, de pagination ou de tri invalide |
| 401 | erreur de passerelle | Échec de l’authentification |
| 404 | `BRAND_NOT_FOUND` | Marque inexistante ou inaccessible |
| 429 | erreur de passerelle | Limite de débit dépassée ; respectez `Retry-After` |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.