/yahoo_shopping/products

POST /api/yahoo_shopping/products

Price: 10 credits

Get full Yahoo! Shopping (Japan) product details by store_alias/item_code (or product URL): title, catch copy, description, brand, price, premium price, list price, PayPay points, free-shipping, sale flag, condition, images, video, rating, review count, recent order count, category breadcrumbs, specifications, store info, SKU variants and cross-store offers summary.

How to use it

Fetch a single Yahoo!ショッピング (Yahoo! Shopping Japan) product by store_alias/item_code (e.g. 'mobilestation/friphone17e256gbm') or a full product URL. Returns one product with title, catch_copy, description, brand, price/premium_price/list_price (JPY), point/point_rate (PayPay), is_free_shipping, is_on_sale, is_used/used_condition, order_count_7day, image+images, has_video+video_thumbnail, rating+review_count, category+category_breadcrumbs, specifications (structured attributes like color/material, each name+values), store (id/alias/name/rating/cancel_ratio), variant_axes, variants (per-SKU stock/price) and offers_summary (cross-store item_count/min_price).

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)

Response

• @type string (default: "YahooShoppingProduct")
• id string required
• item_code string nullable
• url string required
• catch_copy string nullable
• description string nullable
• brand string nullable
• brand_id string nullable
• jan_code string nullable
• image string nullable
• images array (default: [])
• has_video boolean (default: false)
• video_thumbnail string nullable
• price integer nullable
• premium_price integer nullable
• list_price integer nullable
• tax_excluded_price integer nullable
• currency string (default: "JPY")
• point integer nullable
• point_rate number nullable
• is_free_shipping boolean (default: false)
• is_on_sale boolean (default: false)
• is_used boolean (default: false)
• used_condition string nullable
• is_in_stock boolean (default: false)
• order_count_7day integer nullable
• rating number nullable
• review_count integer nullable
• category string nullable
• category_id string nullable
• category_breadcrumbs array (default: [])
• specifications array (default: [])
  • @type string (default: "YahooShoppingProductSpec")
  • name string nullable
  • values array (default: [])
• store object nullable
  • @type string (default: "YahooShoppingProductStore")
  • id string nullable
  • alias string nullable
  • name string nullable
  • rating number nullable
  • rating_count integer nullable
  • cancel_ratio number nullable
  • description string nullable
• variant_axes array (default: [])
  • @type string (default: "YahooShoppingProductVariantAxis")
  • name string nullable
  • values array (default: [])
• variants array (default: [])
  • @type string (default: "YahooShoppingProductSku")
  • id string nullable
  • options object (default: {})
    • * string
  • price integer nullable
  • is_available boolean (default: false)
  • stock_count integer nullable
  • image string nullable
• offers_summary object nullable
  • @type string (default: "YahooShoppingProductOffersSummary")
  • item_count integer nullable
  • min_price integer nullable
  • new_min_price integer nullable
  • used_min_price 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 — 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.