/askul/products/ranking

POST /api/askul/products/ranking

Price: 10 credits

Get the daily ASKUL (アスクル) bestseller ranking: rank, product, price including tax, rating, short description and variant count. Without a category it returns the top of every top-level section; with one it returns the deeper chart of that section or category.

How to use it

Daily bestseller ranking of ASKUL (アスクル). Omit `category` for the cross-section chart, where each item carries the `section` it was ranked in. Pass a section id ('01') or a dash-joined category path ('02-0203-0203001') from askul/categories for a longer chart of that one branch. Most entries are product families (`is_family=true`) — expand them with askul/products/variants.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of ranked products to return (min: 1)
• category string nullable — Category to rank within, as a section id or a dash-joined category path from askul/categories; omit for the site-wide chart across all sections (examples: "01", "02-0203-0203001")

Response

• @type string (default: "AskulRankingItem")
• rank integer required
• id string required
• url string required
• name string required
• is_family boolean required
• section string nullable
• image string nullable
• description string nullable
• price_with_tax number nullable
• has_price_range boolean nullable
• currency string (default: "JPY")
• rating number nullable
• variant_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 — Category not found (well-formed id but ASKUL publishes no ranking for it) 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.