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

> Busque produtos na loja Nykaa e leia as páginas de produto dela em JSON: posições com preços, notas, número de avaliações e marcas na busca, e preço, estoque, vendedor, imagens, especificações e opções em cada página de produto.

Busque produtos na loja Nykaa (nykaa.com) e leia as páginas de produto dela pela API de tarefas assíncronas. Envie `COMMERCE_SERP` com `site` `nykaa` para receber os produtos que uma busca mostra, na ordem da loja, ou `COMMERCE_PRODUCT` com a `url` de um produto para ler esse produto. Cada busca ou página de produto concluída custa **0.5 crédito**.

## Busca

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

Envie a tarefa e depois consulte `GET /v1/async/task/{id}` ou receba o webhook. Veja [Tarefas assíncronas](https://docs.querying.ai/pt/concepts/async-tasks.md).

### Parâmetros

* `site`: Obrigatório. `nykaa`.
* `query`: Obrigatório. Termo de busca, de 1 a 500 caracteres.
* `limit`: Inteiro opcional de 1 a 40, com padrão 20.
* `country`: Opcional. O padrão é `IN`, o país da loja. Qualquer outro país é recusado com `422 REGION_UNSUPPORTED`.

Só os campos de payload listados acima são aceitos. Omita `include`: até `include: {}` retorna `422 VALIDATION_ERROR` em `payload.include` antes da reserva de créditos.

### Exemplo de resposta

```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 do resultado

* `site`, `query` e `country` repetem a requisição. `returnedCount` é o número de itens em `products`.
* Cada produto inclui `rank`, `productId`, `title` e `url`. `productId` é o ID de produto da própria loja. `rank` segue a ordem padrão da loja, e os anúncios que a loja marca como patrocinados ficam de fora.
* `price`, `rating`, `reviewCount`, `imageUrl` e `brand` aparecem quando a página de resultados os mostra. `price` é um número na `currency` do produto (ISO 4217); quando os tamanhos têm preços diferentes, é o menor.
* `rating` usa uma escala de cinco pontos. Números de avaliações abreviados, como 999+, ficam de fora.
* Cada busca retorna produtos da primeira página de resultados da loja, que tem 20 posições, com anúncios patrocinados incluídos. Quando a busca cita uma categoria, a Nykaa mostra a página da categoria, e os produtos vêm dessa página.

## Página de produto

```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`: Obrigatório. Uma página de produto da loja Nykaa, com até 2.048 caracteres: `nykaa.com/{name}/p/{id}`. As `url` de produto que uma busca retorna funcionam como estão. Os parâmetros que não afetam o resultado, como códigos de rastreamento, são removidos antes da leitura.
* `country`: Opcional. O padrão é `IN`, o país da página. Qualquer outro país é recusado com `422 REGION_UNSUPPORTED`.

Só os campos de payload listados acima são aceitos. Omita `include`: até `include: {}` retorna `422 VALIDATION_ERROR` em `payload.include` antes da reserva de créditos.

### Exemplo de resposta

```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 do resultado

* `site`, `country`, `url` e `productId` identificam a página. `url` é a página lida, e `productId` é o mesmo que uma busca retorna. Em um produto com tons ou tamanhos, uma busca retorna o ID de uma opção, e esta leitura retorna o ID da página de produto.
* `title` sempre aparece. `brand`, `price`, `listPrice`, `currency`, `inStock`, `seller`, `rating`, `reviewCount`, `images`, `description`, `specs`, `options` e `categories` aparecem quando a página os mostra.
* `price` é o que um comprador paga conforme a página mostra ao abrir, antes de cupons e frete, em `currency` (ISO 4217). `listPrice` é o preço normal que a página risca, presente quando é maior que `price`. `inStock` é a disponibilidade do produto. `seller` é o lojista que o vende.
* `rating` usa uma escala de cinco pontos com duas casas decimais. `reviewCount` é o número de avaliações.
* `images` lista até 30 fotos da galeria do produto, na ordem da página.
* `description` é texto simples com uma linha por parágrafo, com até 10.000 caracteres; o texto que só aparece dentro de imagens não é incluído.
* `specs` lista até 100 pares `{ name, value }` dos detalhes do produto. `options` lista até 20 escolhas, como tamanho ou cor, cada uma com até 100 `values`; os demais campos descrevem a escolha com que a página abre. `categories` vai da categoria mais ampla à mais específica, com até 10 níveis.

## Erros e cobrança

* Uma busca que não retorna produtos termina como tarefa com falha.
* Uma página de produto que a loja responde com 404 ou 410, como um produto removido, encerra a tarefa com `PAGE_UNAVAILABLE`, e a mensagem traz a resposta da loja. Se a loja recusar a leitura com 403, 412, 429 ou 435, a tarefa espera e tenta de novo por até 6 minutos. As demais leituras com falha, e uma recusa que dure mais, terminam com `ENGINE_NO_RESULT`.
* Só as tarefas concluídas são cobradas: 0.5 crédito por busca ou página de produto.

## Relacionado

* [Flipkart](https://docs.querying.ai/pt/engines/flipkart.md)
* [Myntra](https://docs.querying.ai/pt/engines/myntra.md)
* [Todas as lojas do Commerce](https://docs.querying.ai/pt/engines/overview.md#commerce)
* [Créditos e limites](https://docs.querying.ai/pt/concepts/credits-and-limits.md)


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