/yahoo/auctions/products

POST /api/yahoo/auctions/products

Price: 5 credits

Get a Yahoo! Auctions Japan (Yahoo!オークション) catalog product by id or product page URL — the normalised model that individual auctions are matched to. Returns the product name, photo, lowest current price and lowest buy-it-now price across all live auctions, appraisal availability, the number of live auctions and the auctions themselves with price, bid count, end time, condition, region, shipping cost and seller rating.

How to use it

Fetch a Yahoo! Auctions Japan catalog product by id (the token in /catalog/detail/{id}, e.g. 'z44d34t739') or a full product page URL — use it to compare all live auctions for one exact model. Returns id, url, name, image, lowest_price, lowest_buy_now_price, product_category_id, is_appraisal, listing_count and listings (id, url, name, image, price, buy_now_price, bid_count, end_at, condition, region, shipping_note, shipping_fee, seller_good_rating). Historic sale prices for a model are not published here — use yahoo/auctions/items/closed/search with the model name instead.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Yahoo! Auctions Japan catalog product id or a full product page URL (examples: "z44d34t739", "https://auctions.yahoo.co.jp/catalog/detail/z44d34t739"; minLength: 1)

Response

• @type string (default: "YahooAuctionsProduct")
• id string required
• url string required
• name string required
• image string nullable
• lowest_price integer nullable
• lowest_buy_now_price integer nullable
• product_category_id string nullable
• is_appraisal boolean nullable
• listing_count integer nullable
• listings array (default: [])
  • @type string (default: "YahooAuctionsProductListing")
  • id string required
  • url string required
  • name string required
  • image string nullable
  • price integer nullable
  • buy_now_price integer nullable
  • bid_count integer nullable
  • end_at integer nullable
  • condition string nullable
  • category_id string nullable
  • region string nullable
  • shipping_note string nullable
  • shipping_fee integer nullable
  • is_free_shipping boolean nullable
  • is_appraisal boolean nullable
  • seller_is_store boolean nullable
  • seller_good_rating number 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 id but no such catalog product) 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.