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

# 楽天市場 API

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

楽天市場（rakuten.co.jp）の商品を検索し、商品ページを非同期タスク API で読み取ります。`COMMERCE_SERP` に `site` `rakuten` を指定すると検索結果の商品をストアの順に受け取り、`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": "rakuten", "query": "airpods", "limit": 3 } }'
```

タスクを送信したあと、`GET /v1/async/task/{id}` をポーリングするか Webhook で受け取ります。[非同期タスク](https://docs.querying.ai/ja/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` は 5 点満点です。 999+ のように省略表示されたレビュー数は含みません。
* 検索ごとに、ストアの検索結果の 1 ページ目から商品を取得します。

## 商品ページ

```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`: 必須。楽天市場の商品ページで、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` は小数第 2 位までの 5 点満点の評価です。 `reviewCount` はレビュー数です。
* `images` は商品ギャラリーの写真を、ページの順に最大 30 枚含みます。販売者がギャラリーに入れたバナーやお知らせも含まれます。
* `description` は段落ごとに 1 行のプレーンテキストで、最大 10,000 文字です。画像の中にしかない文字は含みません。
* `descriptionImages` は商品説明の画像を、ページの順に最大 300 枚含みます。販売者が説明に入れたバナーやお知らせも含まれ、画像の中の文字は読み取りません。
* `options` はサイズや色などの選択肢を最大 20 個、選択肢ごとに `values` を最大 100 個含みます。ほかのフィールドは、ページが最初に選択している選択肢のものです。 `categories` は最も広いカテゴリから最も狭いカテゴリまでの、最大 10 階層です。 `gtin` はページに記載された UPC、EAN、JAN です。

## エラーと課金

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

## 関連

* [Yahoo!ショッピング](https://docs.querying.ai/ja/engines/yahoo-shopping.md)
* [Qoo10](https://docs.querying.ai/ja/engines/qoo10.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.