/yahoo_shopping/products/reviews

POST /api/yahoo_shopping/products/reviews

Price: 10 credits

Get Yahoo! Shopping (Japan) product reviews by store_alias/item_code (or product URL): rating, title, text, author, posted date, helpful count, selected options, sub-rating breakdown and review images.

How to use it

Get user reviews of a Yahoo!ショッピング (Yahoo! Shopping Japan) product by store_alias/item_code (e.g. 'mobilestation/friphone17e256gbm') or a full product URL. Returns rating (1-5), title, text, author (masked id), posted_at (unix ms), helpful_count, options (selected color/model etc), sub_ratings (per-aspect breakdown like 耐久性/装着感) and review images.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• item string required — Yahoo! Shopping product as store_alias/item_code or a full product URL (examples: "mobilestation/friphone17e256gbm", "https://store.shopping.yahoo.co.jp/mobilestation/friphone17e256gbm.html"; minLength: 1)
• count integer required — Max number of reviews to return (min: 1)

Response

• @type string (default: "YahooShoppingProductReview")
• id string required
• rating integer nullable
• text string nullable
• author string nullable
• posted_at integer nullable
• helpful_count integer nullable
• options object (default: {})
  • * string
• sub_ratings array (default: [])
  • @type string (default: "YahooShoppingProductReviewSubRating")
  • name string required
  • value string nullable
• images array (default: [])

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 — Product not found (well-formed store_alias/item_code but the product does not exist) 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.