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

> Nykaa の商品を検索し、商品ページを読み取って JSON で受け取ります。検索結果の順位と価格、評価、レビュー数、ブランド、商品ページの価格、在庫、販売者、画像、仕様、オプションを返します。

Nykaa（nykaa.com）の商品を検索し、商品ページを非同期タスク API で読み取ります。`COMMERCE_SERP` に `site` `nykaa` を指定すると検索結果の商品をストアの順に受け取り、`COMMERCE_PRODUCT` に商品の `url` を渡すとその商品を 1 つ読み取ります。完了した検索または商品ページ 1 件につき **0.5 クレジット**です。

## 検索

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

タスクを送信したあと、`GET /v1/async/task/{id}` をポーリングするか Webhook で受け取ります。[非同期タスク](https://docs.querying.ai/ja/concepts/async-tasks.md)を参照してください。

### パラメータ

* `site`: 必須。`nykaa` です。
* `query`: 必須。検索語で、1-500 文字です。
* `limit`: 任意の整数、1-40。デフォルトは 20 です。
* `country`: 任意。デフォルトはストアの国の `IN` です。ほかの国は `422 REGION_UNSUPPORTED` で拒否されます。

受け付けるペイロードフィールドは上記のみです。`include` は省略してください。`include: {}` でも、クレジットを確保する前に `payload.include` の `422 VALIDATION_ERROR` を返します。

### レスポンス例

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

### 結果フィールド

* `site`、`query`、`country` はリクエストの値です。`returnedCount` は `products` の件数です。
* 各商品は `rank`、`productId`、`title`、`url` を含みます。`productId` はストア独自の商品 ID です。`rank` はストアのデフォルトの並び順で、ストアが広告と表示した商品は除きます。
* `price`、`rating`、`reviewCount`、`imageUrl`、`brand` は、検索結果の画面に表示されている場合に含みます。`price` は商品ごとの `currency`（ISO 4217）の数値で、容量ごとに価格が異なる場合は最も低い価格です。
* `rating` は 5 点満点です。 999+ のように省略表示されたレビュー数は含みません。
* 検索ごとに、ストアの検索結果の 1 ページ目から商品を取得します。このページは広告商品を含めて 20 枠です。 Nykaa はカテゴリ名で検索するとカテゴリページを表示し、その場合はそのページの商品を返します。

## 商品ページ

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

### パラメータ

* `url`: 必須。Nykaa の商品ページで、2,048 文字以内です。形式は `nykaa.com/{name}/p/{id}` です。検索結果の商品 `url` はそのまま渡せます。トラッキングコードなど結果に影響しないパラメータは読み取り前に取り除きます。
* `country`: 任意。デフォルトはページの国の `IN` です。ほかの国は `422 REGION_UNSUPPORTED` で拒否されます。

受け付けるペイロードフィールドは上記のみです。`include` は省略してください。`include: {}` でも、クレジットを確保する前に `payload.include` の `422 VALIDATION_ERROR` を返します。

### レスポンス例

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

### 結果フィールド

* `site`、`country`、`url`、`productId` でページを識別します。`url` は読み取ったページで、`productId` は検索結果の ID と同じです。色やサイズのある商品では、検索結果は選択肢の 1 つの ID を、この読み取りは商品ページの ID を返します。
* `title` は常に含みます。`brand`、`price`、`listPrice`、`currency`、`inStock`、`seller`、`rating`、`reviewCount`、`images`、`description`、`specs`、`options`、`categories` は、ページに表示されている場合に含みます。
* `price` は、クーポンと送料を適用する前にページが最初に表示する購入価格で、`currency`（ISO 4217）の値です。 `listPrice` はページが取り消し線で表示する通常価格で、`price` より高い場合だけ含みます。 `inStock` は在庫の有無です。 `seller` は販売者です。
* `rating` は小数第 2 位までの 5 点満点の評価です。 `reviewCount` はレビュー数です。
* `images` は商品ギャラリーの写真を、ページの順に最大 30 枚含みます。
* `description` は段落ごとに 1 行のプレーンテキストで、最大 10,000 文字です。画像の中にしかない文字は含みません。
* `specs` は商品詳細の `{ name, value }` の組を最大 100 個含みます。 `options` はサイズや色などの選択肢を最大 20 個、選択肢ごとに `values` を最大 100 個含みます。ほかのフィールドは、ページが最初に選択している選択肢のものです。 `categories` は最も広いカテゴリから最も狭いカテゴリまでの、最大 10 階層です。

## エラーと課金

* 商品が 1 つもない検索は、失敗したタスクとして終了します。
* ストアが 404 または 410 で応答する商品ページ（削除された商品など）は `PAGE_UNAVAILABLE` で終了し、メッセージにストアの応答が入ります。ストアが 403、412、429、435 で読み取りを拒否した場合、タスクは待機して最大 6 分間再試行します。ほかの読み取り失敗と、それより長く続く拒否は `ENGINE_NO_RESULT` で終了します。
* 課金は完了したタスクだけで、検索または商品ページ 1 件につき 0.5 クレジットです。

## 関連

* [Flipkart](https://docs.querying.ai/ja/engines/flipkart.md)
* [Myntra](https://docs.querying.ai/ja/engines/myntra.md)
* [Commerce のストア一覧](https://docs.querying.ai/ja/engines/overview.md#commerce)
* [クレジットと上限](https://docs.querying.ai/ja/concepts/credits-and-limits.md)


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