/rakuten/shops/items

POST /api/rakuten/shops/items

Price: 10 credits

List all items of a Rakuten Ichiba (楽天市場) shop by its shop code (or shop URL). Returns product cards with title, price range, image, point, free-shipping, rating, review count, category and shop.

How to use it

List the full catalog of a Rakuten Ichiba (楽天市場) shop by its shop code (e.g. 'sawaicoffee-tea') or a full shop URL. Each result has id (shop_code/item_code), item_code, title, subtitle, price+price_max (JPY variant range), image, point, is_free_shipping, is_sold_out, rating+review_count, category+category_id, genre_breadcrumbs and shop (id/name/alias).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• shop string required — Rakuten Ichiba shop as its shop code or a full shop URL (examples: "sawaicoffee-tea", "https://www.rakuten.co.jp/sawaicoffee-tea/"; minLength: 1)
• count integer required — Max number of items to return (min: 1)

Response

• @type string (default: "RakutenShopItem")
• id string required
• item_code string nullable
• url string required
• subtitle string nullable
• image string nullable
• price number nullable
• price_max number nullable
• currency string (default: "JPY")
• point integer nullable
• is_free_shipping boolean (default: false)
• is_sold_out boolean (default: false)
• rating number nullable
• review_count integer nullable
• category_id integer nullable
• category string nullable
• genre_breadcrumbs array (default: [])
• shop object nullable
  • @type string (default: "RakutenShopItemShop")
  • id integer nullable
  • name string nullable
  • alias 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 — Shop not found (well-formed shop code but the shop does not exist) 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.