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

# Yahoo!ショッピング API

> Yahoo!ショッピングの商品を検索し、商品ページを読み取って JSON で受け取ります。検索結果の順位と価格、評価、レビュー数、ブランド、商品ページの価格、在庫、画像を返します。

Yahoo!ショッピング（shopping.yahoo.co.jp）の商品を検索し、商品ページを非同期タスク API で読み取ります。`COMMERCE_SERP` に `site` `yahoo_shopping` を指定すると検索結果の商品をストアの順に受け取り、`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": "yahoo_shopping", "query": "airpods", "limit": 3 } }'
```

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

### パラメータ

* `site`: 必須。`yahoo_shopping` です。
* `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": "yahoo_shopping",
  "query": "airpods",
  "country": "JP",
  "returnedCount": 3,
  "products": [
    {
      "rank": 1,
      "productId": "densidonya_4549995725049-b",
      "title": "【ラッピング可】【即日発送】【新品 保証開始済み品】Apple アップル AirPods 5 MKFW4J/A",
      "url": "https://store.shopping.yahoo.co.jp/densidonya/4549995725049-b.html",
      "price": 21260,
      "currency": "JPY",
      "rating": 4.83,
      "reviewCount": 6,
      "brand": "Apple",
      "imageUrl": "https://item-shopping.c.yimg.jp/i/j/densidonya_4549995725049-b?resolution=2x"
    },
    {
      "rank": 2,
      "productId": "onemorething_4549995635232",
      "title": "Apple アップル 純正 AirPods Pro 3 第3世代 USB-C エアポッズプロ3 エアーポッズプロ3 MFHP4J/A ワイヤレスイヤホン bluetooth メーカー保証付き ラッピング可",
      "url": "https://store.shopping.yahoo.co.jp/onemorething/4549995635232.html",
      "price": 42980,
      "currency": "JPY",
      "rating": 4.87,
      "reviewCount": 52,
      "brand": "Apple",
      "imageUrl": "https://item-shopping.c.yimg.jp/i/j/onemorething_4549995635232?resolution=2x"
    },
    {
      "rank": 3,
      "productId": "densidonya_4549995635232",
      "title": "【ラッピング可】【即日発送】【新品】Apple アップル AirPods Pro 3 MFHP4J/A",
      "url": "https://store.shopping.yahoo.co.jp/densidonya/4549995635232.html",
      "price": 38560,
      "currency": "JPY",
      "rating": 4.71,
      "reviewCount": 93,
      "brand": "Apple",
      "imageUrl": "https://item-shopping.c.yimg.jp/i/j/densidonya_4549995635232?resolution=2x"
    }
  ]
}
```

### 結果フィールド

* `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 ページ目から商品を取得します。このページには最大 30 件の商品が表示されます。

## 商品ページ

```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://store.shopping.yahoo.co.jp/densidonya/4549995725049-b.html" } }'
```

### パラメータ

* `url`: 必須。Yahoo!ショッピングの商品ページで、2,048 文字以内です。形式は `store.shopping.yahoo.co.jp/{store}/{item}.html` です。検索結果の商品 `url` はそのまま渡せます。トラッキングコードなど結果に影響しないパラメータは読み取り前に取り除きます。 LOHACO のページ（`lohaco.yahoo.co.jp`）は読み取りません。
* `country`: 任意。デフォルトはページの国の `JP` です。ほかの国は `422 REGION_UNSUPPORTED` で拒否されます。

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

### レスポンス例

```json theme={"theme":"css-variables"}
{
  "site": "yahoo_shopping",
  "country": "JP",
  "url": "https://store.shopping.yahoo.co.jp/densidonya/4549995725049-b.html",
  "productId": "densidonya_4549995725049-b",
  "title": "【ラッピング可】【即日発送】【新品 保証開始済み品】Apple アップル AirPods 5 MKFW4J/A",
  "price": 21260,
  "currency": "JPY",
  "inStock": true,
  "rating": 4.83,
  "reviewCount": 6,
  "images": ["https://item-shopping.c.yimg.jp/i/n/densidonya_4549995725049-b_i_20260918165546"],
  "description": "■ライブ翻訳Apple Intelligenceを活用したライブ翻訳機能に対応。異なる言語間のコミュニケーションをサポート。■Siri AIよりパワフルになったSiri AIにハンズフリーでアクセス。■適応型オーディオ外部音取り込みモードとアクティブノイズキャンセリングをリアルタイムで融合。■外部音取り込みモード…",
  "categories": ["電子問屋", "カメラ・オーディオ・ＴＶ", "オーディオ関連", "イヤホン"],
  "gtin": "4549995725049"
}
```

### 結果フィールド

* `site`、`country`、`url`、`productId` でページを識別します。`url` は読み取ったページで、`productId` は検索結果の ID と同じです。
* `title` は常に含みます。`brand`、`price`、`currency`、`inStock`、`rating`、`reviewCount`、`images`、`description`、`descriptionImages`、`categories`、`gtin` は、ページに表示されている場合に含みます。
* `price` は、クーポンと送料を適用する前にページが最初に表示する購入価格で、`currency`（ISO 4217）の値です。 `inStock` は在庫の有無です。
* `rating` は小数第 2 位までの 5 点満点の評価です。 `reviewCount` はレビュー数です。
* `images` は商品ギャラリーの写真を、ページの順に最大 30 枚含みます。販売者がギャラリーに入れたバナーやお知らせも含まれます。
* `description` は段落ごとに 1 行のプレーンテキストで、最大 10,000 文字です。画像の中にしかない文字は含みません。
* `descriptionImages` は商品説明の画像を、ページの順に最大 300 枚含みます。販売者が説明に入れたバナーやお知らせも含まれ、画像の中の文字は読み取りません。
* `categories` は最も広いカテゴリから最も狭いカテゴリまでの、最大 10 階層です。 `gtin` はページに記載された UPC、EAN、JAN です。

## エラーと課金

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

## 関連

* [楽天市場](https://docs.querying.ai/ja/engines/rakuten.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.