> ## 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! Shopping API

> Search Yahoo! Shopping and read its product pages as JSON: ranked products with prices, ratings, review counts and brands, and each product's price, stock and images.

Search Yahoo! Shopping (shopping.yahoo.co.jp) and read its product pages through the async task API. Send `COMMERCE_SERP` with `site` `yahoo_shopping` to get the products a search shows, in the store's order, or `COMMERCE_PRODUCT` with a product's `url` to read that product. A completed search or product page costs **0.5 credits**.

## Search

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

Submit the task, then poll `GET /v1/async/task/{id}` or receive its webhook. See [Async tasks](https://docs.querying.ai/concepts/async-tasks.md).

### Parameters

* `site`: Required. `yahoo_shopping`.
* `query`: Required. The search query, 1-500 characters.
* `limit`: Optional integer from 1 to 40, default 20.
* `country`: Optional. Defaults to `JP`, the store's country. Any other country is rejected with `422 REGION_UNSUPPORTED`.

Only the payload fields listed above are accepted. Omit `include`: even `include: {}` returns `422 VALIDATION_ERROR` on `payload.include` before credits are held.

### Response example

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

### Result fields

* `site`, `query` and `country` echo the request. `returnedCount` is the number of entries in `products`.
* Each product includes `rank`, `productId`, `title` and `url`. `productId` is the store's own product ID. `rank` follows the store's default order, and listings the store marks as sponsored are left out.
* `price`, `rating`, `reviewCount`, `imageUrl` and `brand` appear when the results page shows them. `price` is a number in the product's `currency` (ISO 4217); when sizes are priced apart, it is the lowest one.
* `rating` uses a five-point scale. Abbreviated review counts such as 999+ are left out.
* Each search returns products from the store's first results page, which lists up to 30 products.

## Product page

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

### Parameters

* `url`: Required. A product page on Yahoo! Shopping, up to 2,048 characters: `store.shopping.yahoo.co.jp/{store}/{item}.html`. Product `url` values from a search work as they are. Parameters the result does not depend on, such as tracking codes, are dropped before the page is read. LOHACO pages on `lohaco.yahoo.co.jp` are not read.
* `country`: Optional. Defaults to `JP`, the page's country. Any other country is rejected with `422 REGION_UNSUPPORTED`.

Only the payload fields listed above are accepted. Omit `include`: even `include: {}` returns `422 VALIDATION_ERROR` on `payload.include` before credits are held.

### Response example

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

### Result fields

* `site`, `country`, `url` and `productId` identify the page. `url` is the page that was read, and `productId` matches the one a search returns.
* `title` is always present. `brand`, `price`, `currency`, `inStock`, `rating`, `reviewCount`, `images`, `description`, `descriptionImages`, `categories` and `gtin` appear when the page shows them.
* `price` is what a shopper pays as the page first shows it, before coupons and delivery, in `currency` (ISO 4217). `inStock` is the product's stock status.
* `rating` uses a five-point scale with two decimals. `reviewCount` is the number of reviews.
* `images` lists up to 30 photos from the product's gallery, in page order. Banners or notices the seller places in that gallery come along.
* `description` is plain text with one line per paragraph, up to 10,000 characters; text that appears only inside images is not included.
* `descriptionImages` lists up to 300 images from the product description, in page order. Banners and notices that sellers place in their description come along, and text inside the images is not read.
* `categories` runs from the broadest category to the narrowest, up to 10 levels. `gtin` is the UPC, EAN or JAN the page lists.

## Errors and billing

* A search that returns no products ends as a failed task.
* A product page the store answers with 404 or 410, such as a removed product, ends the task with `PAGE_UNAVAILABLE`, and the message carries the store's answer. When the store refuses the read with 403, 412, 429 or 435, the task waits and asks again for up to 6 minutes. Other failed reads, and a refusal that lasts longer, end with `ENGINE_NO_RESULT`.
* Only completed tasks are charged: 0.5 credits for a search or a product page.

## Related

* [Rakuten](https://docs.querying.ai/engines/rakuten.md)
* [Qoo10](https://docs.querying.ai/engines/qoo10.md)
* [All Commerce stores](https://docs.querying.ai/engines/overview.md#commerce)
* [Credits and limits](https://docs.querying.ai/concepts/credits-and-limits.md)


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