> ## 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

> Busca productos en la tienda Nykaa y lee sus páginas de producto como JSON: posiciones con precios, valoraciones, número de reseñas y marcas en la búsqueda, y precio, disponibilidad, vendedor, imágenes, especificaciones y opciones en cada página de producto.

Busca productos en la tienda Nykaa (nykaa.com) y lee sus páginas de producto mediante la API de tareas asíncronas. Envía `COMMERCE_SERP` con `site` `nykaa` para recibir los productos que muestra una búsqueda, en el orden de la tienda, o `COMMERCE_PRODUCT` con la `url` de un producto para leer ese producto. Cada búsqueda o página de producto completada cuesta **0.5 créditos**.

## Búsqueda

```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 } }'
```

Envía la tarea y luego consulta `GET /v1/async/task/{id}` o recibe su webhook. Consulta [Tareas asíncronas](https://docs.querying.ai/es/concepts/async-tasks.md).

### Parámetros

* `site`: Obligatorio. `nykaa`.
* `query`: Obligatorio. Consulta de búsqueda, de 1 a 500 caracteres.
* `limit`: Entero opcional de 1 a 40, con 20 por defecto.
* `country`: Opcional. Por defecto, `IN`, el país de la tienda. Cualquier otro país se rechaza con `422 REGION_UNSUPPORTED`.

Solo se aceptan los campos de payload enumerados arriba. Omite `include`: incluso `include: {}` devuelve `422 VALIDATION_ERROR` en `payload.include` antes de reservar créditos.

### Ejemplo de respuesta

```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"
    }
  ]
}
```

### Campos del resultado

* `site`, `query` y `country` repiten la solicitud. `returnedCount` es el número de elementos de `products`.
* Cada producto incluye `rank`, `productId`, `title` y `url`. `productId` es el ID de producto propio de la tienda. `rank` sigue el orden predeterminado de la tienda, y se omiten los anuncios que la tienda marca como patrocinados.
* `price`, `rating`, `reviewCount`, `imageUrl` y `brand` aparecen cuando la página de resultados los muestra. `price` es un número en la `currency` del producto (ISO 4217); cuando los tamaños tienen precios distintos, es el más bajo.
* `rating` usa una escala de cinco puntos. Los números de reseñas abreviados, como 999+, se omiten.
* Cada búsqueda devuelve productos de la primera página de resultados de la tienda, que tiene 20 posiciones, anuncios patrocinados incluidos. Si la búsqueda nombra una categoría, Nykaa muestra la página de la categoría, y los productos salen de esa página.

## Página de producto

```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" } }'
```

### Parámetros

* `url`: Obligatorio. Una página de producto de la tienda Nykaa, de hasta 2.048 caracteres: `nykaa.com/{name}/p/{id}`. Las `url` de producto que devuelve una búsqueda sirven tal cual. Los parámetros que no afectan al resultado, como los códigos de seguimiento, se quitan antes de leer la página.
* `country`: Opcional. Por defecto, `IN`, el país de la página. Cualquier otro país se rechaza con `422 REGION_UNSUPPORTED`.

Solo se aceptan los campos de payload enumerados arriba. Omite `include`: incluso `include: {}` devuelve `422 VALIDATION_ERROR` en `payload.include` antes de reservar créditos.

### Ejemplo de respuesta

```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"]
}
```

### Campos del resultado

* `site`, `country`, `url` y `productId` identifican la página. `url` es la página que se leyó, y `productId` coincide con el que devuelve una búsqueda. En un producto con tonos o tamaños, una búsqueda devuelve el ID de una opción, y esta lectura devuelve el ID de la página de producto.
* `title` siempre está presente. `brand`, `price`, `listPrice`, `currency`, `inStock`, `seller`, `rating`, `reviewCount`, `images`, `description`, `specs`, `options` y `categories` aparecen cuando la página los muestra.
* `price` es lo que paga un comprador tal como la página lo muestra al abrirse, antes de cupones y envío, en `currency` (ISO 4217). `listPrice` es el precio habitual que la página tacha, presente cuando es mayor que `price`. `inStock` es la disponibilidad del producto. `seller` es el comerciante que lo vende.
* `rating` usa una escala de cinco puntos con dos decimales. `reviewCount` es el número de reseñas.
* `images` lista hasta 30 fotos de la galería del producto, en el orden de la página.
* `description` es texto plano con una línea por párrafo, de hasta 10.000 caracteres; el texto que solo aparece dentro de imágenes no se incluye.
* `specs` lista hasta 100 pares `{ name, value }` de los detalles del producto. `options` lista hasta 20 opciones, como talla o color, cada una con hasta 100 `values`; los demás campos describen la opción con la que se abre la página. `categories` va de la categoría más amplia a la más concreta, con hasta 10 niveles.

## Errores y facturación

* Una búsqueda que no devuelve productos termina como tarea fallida.
* Una página de producto que la tienda responde con 404 o 410, como un producto retirado, termina la tarea con `PAGE_UNAVAILABLE`, y el mensaje incluye la respuesta de la tienda. Si la tienda rechaza la lectura con 403, 412, 429 o 435, la tarea espera y vuelve a consultar durante un máximo de 6 minutos. Las demás lecturas fallidas, y un rechazo que dura más, terminan con `ENGINE_NO_RESULT`.
* Solo se cobran las tareas completadas: 0.5 créditos por búsqueda o página de producto.

## Relacionado

* [Flipkart](https://docs.querying.ai/es/engines/flipkart.md)
* [Myntra](https://docs.querying.ai/es/engines/myntra.md)
* [Todas las tiendas de Commerce](https://docs.querying.ai/es/engines/overview.md#commerce)
* [Créditos y límites](https://docs.querying.ai/es/concepts/credits-and-limits.md)


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