/ruten/sellers

POST /api/ruten/sellers

Price: 1 credit

Get a Ruten seller's store: store name and intro, rating and rating counts, item and follower counts, order completion rates, response time, verification and seller badges

How to use it

The account name is seller_name on ruten/items. Completion rates are shares from 0 to 1.

Parameters

• access-token string required

Request body

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

Response

• @type string (default: "RutenSeller")
• id string required
• alias string required
• url string nullable
• store_name string nullable
• intro string nullable
• image string nullable
• banner string nullable
• background_image string nullable
• rating number nullable
• star_count integer nullable
• rating_count integer nullable
• foreign_rating_count integer nullable
• item_count integer nullable
• follower_count integer nullable
• response_time_hours integer nullable
• average_ship_days number nullable
• order_count integer nullable
• completion_rate number nullable
• completion_rate_24h number nullable
• completion_rate_3_days number nullable
• completion_rate_7_days number nullable
• completion_rate_14_days number nullable
• completion_rate_21_days number nullable
• completion_rate_over_21_days number nullable
• order_count_24h integer nullable
• order_count_3_days integer nullable
• order_count_7_days integer nullable
• order_count_14_days integer nullable
• order_count_21_days integer nullable
• order_count_over_21_days integer nullable
• pi_level string nullable
• platform string nullable
• groups string nullable
• last_active_at integer nullable
• is_phone_verified boolean nullable
• is_email_verified boolean nullable
• is_corporate boolean nullable
• is_overseas boolean nullable
• is_brand_seller boolean nullable
• is_ruten_choice_seller boolean nullable
• is_suspended boolean nullable
• has_auctions 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 seller under that account name 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.