/tsukumo/categories

POST /api/tsukumo/categories

Price: 10 credits

Get the TSUKUMO (ツクモ) product category tree. Without arguments it returns the top level; with a category it returns that category's ancestors, its siblings and its children, each with the number of products behind it.

How to use it

The shop.tsukumo.co.jp category tree. Call it without arguments for the eleven top-level departments, or with a category to walk deeper: that form returns the ancestors, the category itself (is_current), its siblings and its children. Each entry carries id, name, url, parent_id, level and product_count. An id is a colon-joined path such as '20:2005:2005400' and is the category accepted by the products/search and products/facets endpoints; append a colon and a child segment to go one level down. The tree is four levels deep at most.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category string nullable — Return the branch around this category instead of the top level (examples: "20", "20:2005")
• count integer required — Max number of categories to return (min: 1)

Response

• @type string (default: "TsukumoCategory")
• id string required
• name string nullable
• url string required
• parent_id string nullable
• level integer (default: 1)
• product_count integer nullable
• is_current boolean (default: false)

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 — The requested category holds no products on shop.tsukumo.co.jp 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.