/rakuten/categories

POST /api/rakuten/categories

Price: 1 credit

Browse the Rakuten Ichiba genre (category) tree: pass a genre_id to get that genre with its breadcrumb path and child genres (each with item count), or omit it to list all top-level genres.

How to use it

Navigate Rakuten Ichiba's genre taxonomy. Omit genre_id to get the top-level genres (each with id, name, url and its direct child genres). Pass a genre_id (e.g. 100227) to get that single genre with id, name, alias (URL slug), parent_category_id, is_leaf, breadcrumbs (ancestor genre names from the root) and children (subgenres, each with id, name, item_count, is_leaf, url). Drill down by calling again with a child id.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• genre_id integer nullable — Rakuten Ichiba genre id to drill into; omit to list the top-level genres (>: 0)

Response

• @type string (default: "RakutenCategory")
• id integer required
• name string nullable
• alias string nullable
• parent_category_id integer nullable
• is_leaf boolean (default: false)
• url string nullable
• breadcrumbs array (default: [])
• children array (default: [])
  • @type string (default: "RakutenCategoryChild")
  • id integer required
  • name string nullable
  • alias string nullable
  • item_count integer nullable
  • is_leaf boolean (default: false)
  • url string 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 — Genre not found (well-formed but nonexistent genre_id) 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.