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

# Nykaa API

> Recherchez des produits sur la boutique Nykaa et lisez ses pages produit en JSON : classement avec prix, notes, nombres d’avis et marques pour la recherche, et prix, disponibilité, vendeur, images, caractéristiques et options pour chaque page produit.

Recherchez des produits sur la boutique Nykaa (nykaa.com) et lisez ses pages produit via l’API de tâches asynchrones. Envoyez `COMMERCE_SERP` avec `site` `nykaa` pour recevoir les produits qu’affiche une recherche, dans l’ordre de la boutique, ou `COMMERCE_PRODUCT` avec l’`url` d’un produit pour lire ce produit. Une recherche ou une page produit terminée coûte **0.5 crédit**.

## Recherche

```bash theme={"theme":"css-variables"}
curl -X POST https://api.querying.ai/v1/async/task \
  -H "Authorization: Bearer $QUERYING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "taskType": "COMMERCE_SERP", "payload": { "site": "nykaa", "query": "sunscreen", "limit": 3 } }'
```

Soumettez la tâche, puis interrogez `GET /v1/async/task/{id}` ou recevez son webhook. Voir [Tâches asynchrones](https://docs.querying.ai/fr/concepts/async-tasks.md).

### Paramètres

* `site` : obligatoire. `nykaa`.
* `query` : obligatoire. Terme de recherche, de 1 à 500 caractères.
* `limit` : entier facultatif de 1 à 40, avec 20 par défaut.
* `country` : facultatif. Par défaut, `IN`, le pays de la boutique. Tout autre pays est refusé avec `422 REGION_UNSUPPORTED`.

Seuls les champs de payload listés ci-dessus sont acceptés. Omettez `include` : même `include: {}` renvoie `422 VALIDATION_ERROR` sur `payload.include` avant toute réservation de crédits.

### Exemple de réponse

```json theme={"theme":"css-variables"}
{
  "site": "nykaa",
  "query": "sunscreen",
  "country": "IN",
  "returnedCount": 3,
  "products": [
    {
      "rank": 1,
      "productId": "6951199",
      "title": "Beauty Of Joseon Relief Sunscreen Rice + Probiotics SPF 50+ PA++++",
      "url": "https://www.nykaa.com/beauty-of-joseon-relief-sunscreen-rice-probiotics-spf-50-pa/p/16900408",
      "price": 1570,
      "currency": "INR",
      "rating": 4.4,
      "reviewCount": 23582,
      "brand": "Beauty of Joseon",
      "imageUrl": "https://images-static.nykaa.com/media/catalog/product/tr:h-200,w-200,cm-pad_resize/4/c/4c49d98BEAAR00000010b_1.jpg"
    },
    {
      "rank": 2,
      "productId": "14558391",
      "title": "Dot & Key Strawberry Dew Tinted Sunscreen SPF 50+ PA++++",
      "url": "https://www.nykaa.com/dot-key-strawberry-dew-tinted-sunscreen-spf-50-pa/p/14558391",
      "price": 500,
      "currency": "INR",
      "rating": 4.3,
      "reviewCount": 36470,
      "brand": "Dot & Key",
      "imageUrl": "https://images-static.nykaa.com/media/catalog/product/tr:h-200,w-200,cm-pad_resize/0/4/040e1b88906147701775_j1.jpg"
    },
    {
      "rank": 3,
      "productId": "20714391",
      "title": "ISDIN Fotoprotector Fusion Water Magic SPF 50 PA ++++",
      "url": "https://www.nykaa.com/isdin-fotoprotector-fusion-water-magic-spf-50/p/20714391",
      "price": 2850,
      "currency": "INR",
      "rating": 4.6,
      "reviewCount": 6476,
      "brand": "ISDIN",
      "imageUrl": "https://images-static.nykaa.com/media/catalog/product/tr:h-200,w-200,cm-pad_resize/3/d/3dd2633ISDIN00000015_1q.jpg"
    }
  ]
}
```

### Champs du résultat

* `site`, `query` et `country` reprennent la requête. `returnedCount` est le nombre d’éléments de `products`.
* Chaque produit comporte `rank`, `productId`, `title` et `url`. `productId` est l’identifiant produit propre à la boutique. `rank` suit l’ordre par défaut de la boutique, et les annonces que la boutique marque comme sponsorisées sont exclues.
* `price`, `rating`, `reviewCount`, `imageUrl` et `brand` apparaissent quand la page de résultats les affiche. `price` est un nombre dans la `currency` du produit (ISO 4217) ; quand les formats ont des prix différents, c’est le plus bas.
* `rating` utilise une échelle de cinq points. Les nombres d’avis abrégés, comme 999+, sont omis.
* Chaque recherche renvoie les produits de la première page de résultats de la boutique, qui compte 20 emplacements, annonces sponsorisées comprises. Pour une recherche qui nomme une catégorie, Nykaa affiche la page de la catégorie, et les produits viennent alors de cette page.

## Page produit

```bash theme={"theme":"css-variables"}
curl -X POST https://api.querying.ai/v1/async/task \
  -H "Authorization: Bearer $QUERYING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "taskType": "COMMERCE_PRODUCT", "payload": { "url": "https://www.nykaa.com/beauty-of-joseon-relief-sunscreen-rice-probiotics-spf-50-pa/p/16900408" } }'
```

### Paramètres

* `url` : obligatoire. Une page produit de la boutique Nykaa, de 2 048 caractères au plus : `nykaa.com/{name}/p/{id}`. Les `url` de produit renvoyées par une recherche s’utilisent telles quelles. Les paramètres sans effet sur le résultat, comme les codes de suivi, sont retirés avant la lecture.
* `country` : facultatif. Par défaut, `IN`, le pays de la page. Tout autre pays est refusé avec `422 REGION_UNSUPPORTED`.

Seuls les champs de payload listés ci-dessus sont acceptés. Omettez `include` : même `include: {}` renvoie `422 VALIDATION_ERROR` sur `payload.include` avant toute réservation de crédits.

### Exemple de réponse

```json theme={"theme":"css-variables"}
{
  "site": "nykaa",
  "country": "IN",
  "url": "https://www.nykaa.com/beauty-of-joseon-relief-sunscreen-rice-probiotics-spf-50-pa/p/16900408",
  "productId": "16900408",
  "title": "Beauty of Joseon Relief Sunscreen Rice + Probiotics SPF 50+ PA++++",
  "brand": "Beauty of Joseon",
  "price": 1570,
  "currency": "INR",
  "inStock": true,
  "seller": "Nykaa E retail limited",
  "rating": 4.4,
  "reviewCount": 23582,
  "images": [
    "https://images-static.nykaa.com/media/catalog/product/9/d/9d01a90BEAAR00000010_1.jpg",
    "https://images-static.nykaa.com/media/catalog/product/9/d/9d01a90BEAAR00000010_2.jpg"
  ],
  "description": "What it's like when you actually use it",
  "specs": [
    { "name": "Country of origin", "value": "South Korea" },
    { "name": "Expiry", "value": "15 January 2029" }
  ],
  "options": [{ "name": "Weight", "values": ["10ml", "50ml"] }],
  "categories": ["Skin", "Sun Care", "Face Sunscreen"]
}
```

### Champs du résultat

* `site`, `country`, `url` et `productId` identifient la page. `url` est la page lue, et `productId` correspond à celui que renvoie une recherche. Pour un produit avec des teintes ou des tailles, une recherche renvoie l’identifiant d’une option, et cette lecture renvoie celui de la page produit.
* `title` est toujours présent. `brand`, `price`, `listPrice`, `currency`, `inStock`, `seller`, `rating`, `reviewCount`, `images`, `description`, `specs`, `options` et `categories` apparaissent quand la page les affiche.
* `price` est ce que paie un acheteur tel que la page l’affiche à l’ouverture, avant coupons et livraison, en `currency` (ISO 4217). `listPrice` est le prix habituel que la page barre, présent quand il dépasse `price`. `inStock` indique la disponibilité du produit. `seller` est le marchand qui le vend.
* `rating` utilise une échelle de cinq points avec deux décimales. `reviewCount` est le nombre d’avis.
* `images` liste jusqu’à 30 photos de la galerie du produit, dans l’ordre de la page.
* `description` est du texte brut avec une ligne par paragraphe, jusqu’à 10 000 caractères ; le texte qui n’apparaît que dans des images n’est pas inclus.
* `specs` liste jusqu’à 100 paires `{ name, value }` des caractéristiques du produit. `options` liste jusqu’à 20 choix, comme la taille ou la couleur, chacun avec jusqu’à 100 `values` ; les autres champs décrivent le choix sur lequel la page s’ouvre. `categories` va de la catégorie la plus large à la plus précise, sur 10 niveaux au plus.

## Erreurs et facturation

* Une recherche qui ne renvoie aucun produit se termine par une tâche en échec.
* Une page produit à laquelle la boutique répond 404 ou 410, comme un produit retiré, termine la tâche avec `PAGE_UNAVAILABLE`, et le message reprend la réponse de la boutique. Si la boutique refuse la lecture avec 403, 412, 429 ou 435, la tâche attend et redemande pendant 6 minutes au plus. Les autres lectures échouées, et un refus qui dure plus longtemps, se terminent par `ENGINE_NO_RESULT`.
* Seules les tâches terminées sont facturées : 0.5 crédit par recherche ou page produit.

## Voir aussi

* [Flipkart](https://docs.querying.ai/fr/engines/flipkart.md)
* [Myntra](https://docs.querying.ai/fr/engines/myntra.md)
* [Toutes les boutiques Commerce](https://docs.querying.ai/fr/engines/overview.md#commerce)
* [Crédits et limites](https://docs.querying.ai/fr/concepts/credits-and-limits.md)


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