/misumi/categories

POST /api/misumi/categories

Price: 20 credits

Browse the MISUMI (ミスミ) category tree: id, name, description, image, parent chain, and — for a single requested category — its child categories with product counts, the manufacturers selling in it, and the specification filters (with their allowed values) that misumi/products/search accepts for that category.

How to use it

Navigate the MISUMI category tree. With no `category` this returns the top level of the catalog; with a `category` it returns that node plus its children, the manufacturers present in it and its `filters` — the specification axes (thread size, material, stroke …) with every allowed value. Those `filters[].id` and `filters[].values[].value` pairs are exactly what misumi/products/search takes in `attributes`, so this endpoint is the lookup you need before filtering a search by specification. `keyword` searches category names instead of walking the tree. `manufacturer` restricts the list to the categories one manufacturer sells in.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category string nullable — Category id or category URL. Omit to list the top level of the catalog (examples: "M3311010000", "mech_screw")
• keyword string nullable — Find categories whose name matches this keyword (examples: "ボルト"; minLength: 1)
• manufacturer string nullable — Only the categories this manufacturer sells in, as returned by misumi/manufacturers (examples: "SMC1")
• count integer required — Max number of categories to return (min: 1)

Response

• @type string (default: "MisumiCategory")
• id string required
• name string required
• url string nullable
• description string nullable
• image string nullable
• department_id string nullable
• parent_ids array (default: [])
• series_count integer nullable
• children array (default: [])
  • @type string (default: "MisumiCategoryChild")
  • id string required
  • name string required
  • url string nullable
  • series_count integer nullable
• filters array (default: [])
  • @type string (default: "MisumiCategoryFilter")
  • id string required
  • name string required
  • code string nullable
  • unit string nullable
  • values array (default: [])
    • @type string (default: "MisumiCategoryFilterValue")
    • value string required
    • name string required
• brands array (default: [])
  • @type string (default: "MisumiCategoryChild")
  • id string required
  • name string required
  • url string nullable
  • series_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 — No MISUMI category matches the request 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.