/yahoo_shopping/products/search

POST /api/yahoo_shopping/products/search

Price: 10 credits

Search Yahoo! Shopping (Japan) products by keyword with optional price/category/brand/condition/free-shipping filters and sort order. Returns id (store_alias/item_code), title, price, list price, discount, PayPay points, image, brand, rating, review count and store info per result.

How to use it

Search Yahoo!ショッピング (Yahoo! Shopping Japan) products by keyword. Optional filters: price_min/price_max (JPY), category_id, brand_id, condition (new/used), free_shipping; sort by recommended/price/review/discount. Each result has id (store_alias/item_code), item_code, store_alias, url, title, image, price/actual_price/list_price/discount_rate (JPY), point/point_rate (PayPay), is_free_shipping, is_used, has_video, brand/brand_id, jan_code, category_id, rating/review_count and store (alias/name/rating/rating_count).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Search keyword (examples: "iphone", "nintendo switch"; minLength: 1)
• count integer required — Max number of results to return (min: 1)
• price_min integer nullable — Minimum price filter (JPY) (min: 0)
• price_max integer nullable — Maximum price filter (JPY) (min: 0)
• category_id string nullable — Category ID filter
• brand_id string nullable — Brand ID filter
• condition string nullable — Item condition filter (one of: "new", "used")
• free_shipping boolean — Only items with free shipping (default: false)
• sort string — Result ordering (default: "recommended"; one of: "recommended", "price_asc", "price_desc", "review_count", "review_score", "discount_rate")

Response

• @type string (default: "YahooShoppingSearchProduct")
• id string required
• item_code string nullable
• store_alias string nullable
• url string required
• image string nullable
• price integer nullable
• actual_price integer nullable
• list_price integer nullable
• discount_rate integer nullable
• currency string (default: "JPY")
• point integer nullable
• point_rate number nullable
• is_free_shipping boolean (default: false)
• is_used boolean (default: false)
• has_video boolean (default: false)
• brand string nullable
• brand_id string nullable
• jan_code string nullable
• category_id string nullable
• rating number nullable
• review_count integer nullable
• store object nullable
  • @type string (default: "YahooShoppingSearchProductStore")
  • alias string nullable
  • name string nullable
  • rating number nullable
  • rating_count integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.