/tokopedia/products/reviews

POST /api/tokopedia/products/reviews

Price: 1 credit

Get customer reviews for a Tokopedia product by product id, product URL, or the shop/slug path from it: rating, text, reviewer, purchased variant, photos, videos, likes and the seller response. Filter by star rating.

How to use it

Fetch customer reviews for a Tokopedia product by product id (e.g. 8485253547), product URL or shop/slug path. Supports sort (helpful, newest, oldest, highest, lowest) and rating (1-5). Each review has id, rating, text (in Indonesian), variant, author, author_id, author_url, author_image, is_anonymous, created_at (unix seconds), like_count, images, videos and the seller response_text/response_at. Returns up to `count` reviews.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Tokopedia product id, product page URL, or the shop/slug path from it (examples: "8485253547", "basain-official/basain-casing-iphone-12-pro-soft-silicone-2-0-case-black"; minLength: 1)
• count integer required — Max number of reviews to return (min: 1)
• sort string — Review ordering (default: "helpful"; one of: "helpful", "newest", "oldest", "highest", "lowest")
• rating integer nullable — Only reviews with this star rating (min: 1; max: 5)

Response

• @type string (default: "TokopediaProductReview")
• id string required
• rating integer nullable
• text string nullable
• variant string nullable
• author string nullable
• author_id string nullable
• author_url string nullable
• author_image string nullable
• is_anonymous boolean nullable
• created_at integer nullable
• like_count integer nullable
• images array (default: [])
• videos array (default: [])
• response_text string nullable
• response_at 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 — Product not found (well-formed but nonexistent product id/URL) 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.