/tokopedia/products

POST /api/tokopedia/products

Price: 10 credits

Get full Tokopedia product details by product URL (or the shop/slug path from it): name, price, list_price, discount, images, videos, rating, review_count, sold_count, stock, condition, weight, min/max order, description, category breadcrumbs and shop.

How to use it

Fetch a single Tokopedia (Indonesia's largest marketplace) product by its page URL or the shop/slug path from it. Returns one item with id, alias, url, name, price/list_price/discount/currency (IDR), image+images, videos, rating, review_count, sold_count, stock, min_order, max_order, weight, weight_unit, condition (NEW/USED), status, is_preorder, is_cod, is_wholesale, has_variants, description, category, breadcrumbs, categories and shop (id/name/domain/official).

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 page URL, or the shop/slug path from it (examples: "https://www.tokopedia.com/basain-official/basain-casing-iphone-12-pro-soft-silicone-2-0-case-black", "basain-official/basain-casing-iphone-12-pro-soft-silicone-2-0-case-black"; minLength: 1)

Response

• @type string (default: "TokopediaProduct")
• id string required
• alias string nullable
• url string nullable
• name string nullable
• price number nullable
• list_price number nullable
• discount integer nullable
• currency string (default: "IDR")
• image string nullable
• images array (default: [])
• videos array (default: [])
• rating number nullable
• review_count integer nullable
• sold_count integer nullable
• stock integer nullable
• min_order integer nullable
• max_order integer nullable
• weight number nullable
• weight_unit string nullable
• condition string nullable
• status string nullable
• is_preorder boolean nullable
• is_cod boolean nullable
• is_wholesale boolean nullable
• description string nullable
• category_id string nullable
• category string nullable
• breadcrumbs array (default: [])
• categories array (default: [])
  • @type string (default: "TokopediaProductCategory")
  • id string required
  • name string nullable
  • url string nullable
• has_variants boolean nullable
• shop object nullable
  • @type string (default: "TokopediaProductShop")
  • id string required
  • name string nullable
  • domain string nullable
  • url string nullable
  • is_official boolean nullable
  • is_power_merchant boolean nullable
• created_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 URL/slug) 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.