/biccamera/categories

POST /api/biccamera/categories

Price: 5 credits

List the Bic Camera (ビックカメラ) category tree: category path, display name, parent path and depth. Category paths are the category_id accepted by the product search and ranking endpoints.

How to use it

List biccamera.com categories. Without arguments it returns the whole tree ordered by path; pass category_id to return one subtree (e.g. '001/150' for home appliances) and max_level to cut the depth. Each entry has id (the path used as category_id in the products search and ranking endpoints), url, name, parent_id, level and has_listing — categories above level 3 are navigation hubs that only list products when a keyword is supplied as well.

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 only this category and the categories under it, e.g. '001/150' (examples: "001/150")
• max_level integer nullable — Deepest level to return, counted from the catalogue root (min: 1; max: 6)
• count integer required — Max number of categories to return (min: 1)

Response

• @type string (default: "BiccameraCategory")
• id string required
• url string required
• name string required
• parent_id string nullable
• level integer required
• has_listing 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 entity was not found, or a precondition failed 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.