/askul/categories

POST /api/askul/categories

Price: 20 credits

Browse the ASKUL (アスクル) category tree. Without a category it lists the 18 top-level sections with their product counts, section image and second-level categories; with one it returns that category with its child categories and the full filter catalogue (category-specific specification facets, makers, brands, series, product programme tags and price buckets) accepted by askul/products/search.

How to use it

Map the ASKUL (アスクル) catalog. Call it without `category` for the 18 sections, then pass a `children[].id` back in to drill down — ids are dash-joined paths ('02', '02-0203', '02-0203-0203001') and the same value is what askul/products/search and askul/products/ranking take as `category`. A drilled-in call also returns the filter catalogue for that category: `specs[].options[].id` feeds `specs`, `makers[].id` feeds `maker`, `brands[].id` feeds `brand`, `series[].id` feeds `series` and `tags[].id` feeds `tags` of askul/products/search. Specification facets are category-specific — always read them for the category you intend to search.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category string nullable — Dash-joined category path to drill into; omit to list the top-level sections (examples: "02", "02-0203", "02-0203-0203001")

Response

• @type string (default: "AskulCategory")
• id string required
• name string nullable
• url string nullable
• image string nullable
• product_count integer nullable
• children array (default: [])
  • @type string (default: "AskulCategoryRef")
  • id string required
  • name string required
  • url string nullable
  • product_count integer nullable
• specs array (default: [])
  • @type string (default: "AskulSpecFilter")
  • id string required
  • name string required
  • options array (default: [])
    • @type string (default: "AskulFacetOption")
    • id string required
    • name string nullable
    • product_count integer nullable
• makers array (default: [])
  • @type string (default: "AskulFacetOption")
  • id string required
  • name string nullable
  • product_count integer nullable
• brands array (default: [])
  • @type string (default: "AskulFacetOption")
  • id string required
  • name string nullable
  • product_count integer nullable
• series array (default: [])
  • @type string (default: "AskulFacetOption")
  • id string required
  • name string nullable
  • product_count integer nullable
• tags array (default: [])
  • @type string (default: "AskulFacetOption")
  • id string required
  • name string nullable
  • product_count integer nullable
• price_buckets array (default: [])
  • @type string (default: "AskulPriceBucket")
  • price_min integer nullable
  • price_max integer nullable
  • product_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 path but no such category on ASKUL) 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.