> ## 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 获取结果：搜索结果的排名、价格、评分、评价数和品牌，以及商品页面的价格、库存、卖家、图片、规格和选项。

通过异步任务 API 搜索 Nykaa（nykaa.com）的商品并读取商品页面。发送 `COMMERCE_SERP` 并设置 `site` `nykaa`，按商城的顺序获取搜索结果中的商品；向 `COMMERCE_PRODUCT` 传入商品的 `url`，读取该商品。每次完成的搜索或商品页面消耗 **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/zh/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` 为五分制。像 999+ 这样的缩写评价数不会返回。
* 每次搜索从商城搜索结果的第一页获取商品，这一页有 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 一致。对于有色号或规格的商品，搜索返回其中一个选项的 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` 为五分制，保留两位小数。 `reviewCount` 是评价数。
* `images` 按页面顺序列出商品图库中最多 30 张图片。
* `description` 是每段一行的纯文本，最多 10,000 个字符；只出现在图片中的文字不包含在内。
* `specs` 列出商品详情中最多 100 组 `{ name, value }`。 `options` 列出尺寸或颜色等最多 20 个选项，每个选项最多 100 个 `values`；其他字段描述页面默认打开的选项。 `categories` 从最宽的类目排到最窄的类目，最多 10 级。

## 错误与计费

* 没有返回任何商品的搜索以失败任务结束。
* 商城以 404 或 410 响应的商品页面（例如已下架的商品）会以 `PAGE_UNAVAILABLE` 结束任务，消息中带有商城的响应。如果商城以 403、412、429 或 435 拒绝读取，任务会等待并在最多 6 分钟内重新请求。其他读取失败，以及持续更久的拒绝，以 `ENGINE_NO_RESULT` 结束。
* 只对完成的任务计费：每次搜索或每个商品页面 0.5 积分。

## 相关

* [Flipkart](https://docs.querying.ai/zh/engines/flipkart.md)
* [Myntra](https://docs.querying.ai/zh/engines/myntra.md)
* [全部 Commerce 商城](https://docs.querying.ai/zh/engines/overview.md#commerce)
* [积分与限制](https://docs.querying.ai/zh/concepts/credits-and-limits.md)


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