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

# Rakuten API

> 搜索 Rakuten 的商品并读取商品页面，以 JSON 获取结果：搜索结果的排名、价格、评分和评价数，以及商品页面的价格、库存、卖家、图片和选项。

通过异步任务 API 搜索 Rakuten（rakuten.co.jp）的商品并读取商品页面。发送 `COMMERCE_SERP` 并设置 `site` `rakuten`，按商城的顺序获取搜索结果中的商品；向 `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": "rakuten", "query": "airpods", "limit": 3 } }'
```

提交任务后，轮询 `GET /v1/async/task/{id}` 或通过 webhook 接收。参见[异步任务](https://docs.querying.ai/zh/concepts/async-tasks.md)。

### 参数

* `site`：必填。值为 `rakuten`。
* `query`：必填。搜索词，1-500 个字符。
* `limit`：可选整数，范围 1-40，默认 20。
* `country`：可选。默认是商城所在国家 `JP`。其他国家会以 `422 REGION_UNSUPPORTED` 拒绝。

仅接受上方列出的载荷字段。请省略 `include`：即使是 `include: {}`，也会在冻结积分前返回针对 `payload.include` 的 `422 VALIDATION_ERROR`。

### 响应示例

```json theme={"theme":"css-variables"}
{
  "site": "rakuten",
  "query": "airpods",
  "country": "JP",
  "returnedCount": 3,
  "products": [
    {
      "rank": 1,
      "productId": "rakutenmobile-store:apple-rm2609008",
      "title": "【新登場】 Apple AirPods 5",
      "url": "https://item.rakuten.co.jp/rakutenmobile-store/apple-rm2609008/?variantId=apple-rm2609008",
      "price": 23800,
      "currency": "JPY",
      "rating": 5,
      "reviewCount": 10,
      "imageUrl": "https://thumbnail.image.rakuten.co.jp/@0_mall/rakutenmobile-store/cabinet/item/apple-rm2609008/main.jpg"
    },
    {
      "rank": 2,
      "productId": "rakutenmobile-store:apple-rm2609007",
      "title": "【新登場】 Apple ワイヤレス充電ケース付きAirPods 5",
      "url": "https://item.rakuten.co.jp/rakutenmobile-store/apple-rm2609007/?variantId=apple-rm2609007",
      "price": 27800,
      "currency": "JPY",
      "rating": 5,
      "reviewCount": 16,
      "imageUrl": "https://thumbnail.image.rakuten.co.jp/@0_mall/rakutenmobile-store/cabinet/item/apple-rm2609007/main.jpg"
    },
    {
      "rank": 3,
      "productId": "rakutenmobile-store:apple-rm2509012",
      "title": "Apple AirPods Pro 3",
      "url": "https://item.rakuten.co.jp/rakutenmobile-store/apple-rm2509012/?variantId=apple-rm2509012",
      "price": 42799,
      "currency": "JPY",
      "rating": 4.57,
      "reviewCount": 185,
      "imageUrl": "https://thumbnail.image.rakuten.co.jp/@0_mall/rakutenmobile-store/cabinet/item/apple-rm2509012/main_2606.jpg"
    }
  ]
}
```

### 结果字段

* `site`、`query` 和 `country` 回显请求。`returnedCount` 是 `products` 中的商品数。
* 每个商品包含 `rank`、`productId`、`title` 和 `url`。`productId` 是由商品页面的店铺 ID 和商品 ID 组成的 `shop:item`。`rank` 遵循商城的默认排序，商城标为广告的商品会被跳过。
* 搜索结果页显示时返回 `price`、`rating`、`reviewCount` 和 `imageUrl`。`price` 是以商品的 `currency`（ISO 4217）计的数字；不同规格分别定价时，取最低价。
* `rating` 为五分制。像 999+ 这样的缩写评价数不会返回。
* 每次搜索从商城搜索结果的第一页获取商品。

## 商品页面

```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://item.rakuten.co.jp/rakutenmobile-store/apple-rm2609008/" } }'
```

### 参数

* `url`：必填。Rakuten 的商品页面，最多 2,048 个字符，格式为 `item.rakuten.co.jp/{shop}/{item}/`。搜索返回的商品 `url` 可直接使用。跟踪代码等不影响结果的参数会在读取前去掉。
* `country`：可选。默认是页面所在国家 `JP`。其他国家会以 `422 REGION_UNSUPPORTED` 拒绝。

仅接受上方列出的载荷字段。请省略 `include`：即使是 `include: {}`，也会在冻结积分前返回针对 `payload.include` 的 `422 VALIDATION_ERROR`。

### 响应示例

```json theme={"theme":"css-variables"}
{
  "site": "rakuten",
  "country": "JP",
  "url": "https://item.rakuten.co.jp/rakutenmobile-store/apple-rm2609008/",
  "productId": "rakutenmobile-store:apple-rm2609008",
  "title": "【新登場】 Apple AirPods 5",
  "price": 23800,
  "currency": "JPY",
  "inStock": true,
  "seller": "楽天モバイル公式 楽天市場店",
  "rating": 5,
  "reviewCount": 10,
  "images": [
    "https://tshop.r10s.jp/rakutenmobile-store/cabinet/item/apple-rm2609008/main.jpg",
    "https://tshop.r10s.jp/rakutenmobile-store/cabinet/item/apple-rm2609008/pht-accessory-01.jpg"
  ],
  "descriptionImages": [
    "https://image.rakuten.co.jp/rakutenmobile-store/cabinet/product/common/pc/faq_pc.jpg",
    "https://image.rakuten.co.jp/rakutenmobile-store/cabinet/item/apple-rm2609008/pc-section01_1.jpg"
  ],
  "categories": ["TV・オーディオ・カメラ", "オーディオ", "ヘッドホン・イヤホン"]
}
```

### 结果字段

* `site`、`country`、`url` 和 `productId` 标识页面。`url` 是读取的页面，`productId` 与搜索返回的 ID 一致。
* `title` 始终返回。页面显示时返回 `price`、`currency`、`inStock`、`seller`、`rating`、`reviewCount`、`images`、`description`、`descriptionImages`、`options`、`categories` 和 `gtin`。
* `price` 是页面最初显示、未计优惠券和运费的购买价格，以 `currency`（ISO 4217）计。 `inStock` 是商品的库存状态。 `seller` 是销售该商品的商家。
* `rating` 为五分制，保留两位小数。 `reviewCount` 是评价数。
* `images` 按页面顺序列出商品图库中最多 30 张图片。卖家放在图库中的横幅或公告也会一并返回。
* `description` 是每段一行的纯文本，最多 10,000 个字符；只出现在图片中的文字不包含在内。
* `descriptionImages` 按页面顺序列出商品描述中最多 300 张图片。卖家放在描述里的横幅和公告也会一并返回，图片中的文字不会读取。
* `options` 列出尺寸或颜色等最多 20 个选项，每个选项最多 100 个 `values`；其他字段描述页面默认打开的选项。 `categories` 从最宽的类目排到最窄的类目，最多 10 级。 `gtin` 是页面列出的 UPC、EAN 或 JAN。

## 错误与计费

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

## 相关

* [Yahoo! Shopping](https://docs.querying.ai/zh/engines/yahoo-shopping.md)
* [Qoo10](https://docs.querying.ai/zh/engines/qoo10.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.