/ruten/items/search

POST /api/ruten/items/search

Price: 5 credits

Search Ruten items by keyword, with sort, price range, ship-from area and category filters: item cards with price, stock, sold count, seller, shipping cost, payment and delivery codes and badges

How to use it

Prices are in TWD. Ruten serves at most the first 4000 matches of a query, so narrow with filters to reach more.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of items to return (min: 1; max: 4000)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "price_asc", "price_desc", "best_selling", "newest", "item_rating", "seller_rating")
• price_min integer nullable — Minimum price in TWD (min: 0)
• price_max integer nullable — Maximum price in TWD (min: 0)
• ship_from string nullable — Keep items shipped from Taiwan, or from one city or county (one of: "taiwan", "taipei_city", "keelung_city", "new_taipei_city", "yilan_county", "hsinchu_city", "hsinchu_county", "taoyuan_city", "miaoli_county", "taichung_city", "changhua_county", "nantou_county", "chiayi_city", "chiayi_county", "yunlin_county", "tainan_city", "kaohsiung_city", "pingtung_county", "taitung_county", "hualien_county", "penghu_county", "kinmen_county", "lienchiang_county")
• keyword string required — Search keyword (examples: "耳機"; minLength: 1)
• category_id string nullable — Ruten category id or category URL (examples: "00210001")

Response

• @type string (default: "RutenListedItem")
• id string required
• name string nullable
• url string nullable
• image string nullable
• price number nullable
• price_max number nullable
• currency string nullable
• category_id string nullable
• seller_id string nullable
• seller_name string nullable
• store_name string nullable
• seller_credit integer nullable
• is_corporate_seller boolean nullable
• stock_quantity integer nullable
• sold_count integer nullable
• bid_count integer nullable
• sale_type string nullable
• payment_codes array (default: [])
• delivery_codes array (default: [])
• shipping_cost number nullable
• stock_status string nullable
• posted_at integer nullable
• closes_at integer nullable
• sale_start_at integer nullable
• tags array (default: [])
• has_free_shipping boolean nullable
• has_shipping_discount boolean nullable
• has_seller_discount boolean nullable
• is_ruten_choice boolean nullable
• is_brand_store boolean nullable
• is_3c_alliance boolean nullable
• ships_in_24h boolean nullable
• ships_in_3_days boolean nullable
• is_adult 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 — 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.