/tokopedia/shops

POST /api/tokopedia/shops

Price: 5 credits

Get a Tokopedia shop (seller) by domain or shop page URL: name, description, location, official/gold badge, tier, open-since, favorite count, product count, sold count, transaction count, rating, review count, logo and cover.

How to use it

Fetch a single Tokopedia shop (seller) by its domain (e.g. basain-official) or shop page URL. Returns one item with id, name, domain, url, description, location, city, district, image, cover, is_official, is_gold, shop_tier, badge, open_since, favorite_count, product_count, sold_count, transaction_success_count, showcase_count, is_open, status, rating and review_count.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• shop string required — Tokopedia shop domain or a shop page URL containing it (examples: "basain-official", "https://www.tokopedia.com/basain-official"; minLength: 1)

Response

• @type string (default: "TokopediaShop")
• id string required
• name string nullable
• domain string nullable
• url string nullable
• description string nullable
• location string nullable
• city string nullable
• district string nullable
• image string nullable
• cover string nullable
• is_official boolean nullable
• is_gold boolean nullable
• shop_tier integer nullable
• badge string nullable
• open_since string nullable
• favorite_count integer nullable
• product_count integer nullable
• sold_count integer nullable
• transaction_success_count integer nullable
• showcase_count integer nullable
• is_open boolean nullable
• status integer nullable
• rating number nullable
• review_count integer 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 but nonexistent shop domain) 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.