/ruten/items

POST /api/ruten/items

Price: 5 credits

Get a Ruten item: name, prices, images, description, variants with stock, shipping options and costs, payment codes, location, sold and question counts, item rating and the seller's store and rating

How to use it

Prices are in TWD. Find item ids with ruten/items/search; buyer ratings are on ruten/items/reviews.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• item string required — Ruten item id or item URL (examples: "21926881733820", "https://www.ruten.com.tw/item/21926881733820/")

Response

• @type string (default: "RutenItem")
• id string required
• name string nullable
• url string nullable
• images array (default: [])
• price number nullable
• price_max number nullable
• list_price number nullable
• currency string nullable
• condition_code string nullable
• sale_mode string nullable
• location string nullable
• category_id string nullable
• isbn string nullable
• gtin string nullable
• stock_quantity integer nullable
• sold_count integer nullable
• bid_count integer nullable
• question_count integer nullable
• purchase_limit integer nullable
• rating number nullable
• rating_count integer nullable
• tags array (default: [])
• variants array (default: [])
  • @type string (default: "RutenItemVariant")
  • id string required
  • name string nullable
  • parent_id string nullable
  • price number nullable
  • list_price number nullable
  • stock_quantity integer nullable
  • is_available boolean nullable
• shipping_options array (default: [])
  • @type string (default: "RutenShippingOption")
  • code string required
  • name string nullable
  • cost number nullable
  • list_cost number nullable
  • bulk_discount_text string nullable
• payment_codes array (default: [])
• video_url string nullable
• ncc_check_code string nullable
• bsmi_code string nullable
• description string nullable
• description_images array (default: [])
• posted_at integer nullable
• off_shelf_at integer nullable
• updated_date integer nullable
• pre_order_ship_date integer nullable
• is_pre_order boolean nullable
• is_active boolean nullable
• is_sold_out boolean nullable
• has_stock boolean nullable
• has_fast_ship boolean nullable
• seller_id string nullable
• seller_name string nullable
• store_name string nullable
• seller_rating number nullable
• seller_rating_count integer nullable
• seller_item_count integer nullable
• seller_last_login_at integer nullable
• seller_pi_level string nullable
• is_foreign_seller boolean nullable
• is_ruten_choice_seller boolean nullable
• is_brand_seller boolean 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 Ruten item under that 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.