/sofmap/categories

POST /api/sofmap/categories

Price: 5 credits

Get the Sofmap (ソフマップ) category tree. Without arguments it returns every top-level category with its second level; with a category it returns that category's ancestors and children together with the number of products behind each one.

How to use it

The sofmap.com category tree. Call it without arguments for the two top levels of the whole catalogue, or with a category_id to walk deeper: that form returns the ancestors, the category itself (is_current) and its children, each with product_count. Every id is the category_id accepted by the products/search, products/ranking and products/facets endpoints. The second-hand リコレ！ store has its own separate tree behind the used_products/categories endpoint.

Parameters

• access-token string required

Request body

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

Response

• @type string (default: "SofmapCategory")
• id string required
• name string nullable
• url string required
• parent_id string nullable
• 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 does not exist on sofmap.com 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.