/rakuma/categories/items

POST /api/rakuma/categories/items

Price: 10 credits

Browse every Rakuma listing filed under one category, at any depth of the tree, with the filters the category page itself offers: colour, price range, on-sale or sold-out, and ordering by relevance, newest, likes or price. Colour is the one facet Rakuma exposes here and not in the keyword search.

How to use it

List Rakuma listings inside a category. category_id comes from rakuma/categories and may be a root, a middle node or a leaf. color accepts black, white, grey, brown, beige, green, blue, purple, yellow, pink, red, orange, silver, gold or multicolor — this facet exists only here and on rakuma/brands/items, not on rakuma/items/search. Each result has id (feed it to rakuma/items), name, price, is_sold, brand, category, seller_id, image and url.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• color string nullable — Only listings tagged with this colour (one of: "black", "white", "grey", "brown", "beige", "green", "blue", "purple", "yellow", "pink", "red", "orange", "silver", "gold", "multicolor")
• min_price integer nullable — Lowest price in JPY (min: 0)
• max_price integer nullable — Highest price in JPY (min: 0)
• transaction string — Whether to include listings still on sale, sold ones or both (default: "all"; one of: "all", "on_sale", "sold_out")
• sort string — Field the results are ordered by (default: "relevance"; one of: "relevance", "created_at", "like_count", "price")
• order string — Direction of the ordering (default: "desc"; one of: "asc", "desc")
• count integer required — Max number of listings to return (min: 1; max: 3600)
• category_id integer required — Category id to list, at any depth, taken from rakuma/categories (>: 0)

Response

• @type string (default: "RakumaItemCard")
• id string required
• internal_id integer nullable
• name string required
• price number nullable
• currency string (default: "JPY")
• is_sold boolean (default: false)
• brand object nullable
  • @type string (default: "RakumaBrandRef")
  • id integer required
  • name string nullable
  • url string nullable
• category object nullable
  • @type string (default: "RakumaCategoryRef")
  • id integer nullable
  • name string nullable
  • url string nullable
• category_path array (default: [])
  • @type string (default: "RakumaCategoryRef")
  • id integer nullable
  • name string nullable
  • url string nullable
• seller_id integer nullable
• seller_type string nullable
• image string nullable
• 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 — Category not found (well-formed but nonexistent category_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.