/tokopedia/shops/search

POST /api/tokopedia/shops/search

Price: 5 credits

Search Tokopedia shops (sellers) by keyword, optionally filtered by location and seller type (mall or power shop). Returns shop cards: name, domain, location, favorite count, official/gold flags, logo, a few preview products and free-shipping availability.

How to use it

Search Tokopedia (Indonesia's largest marketplace) shops (sellers) by keyword, optionally filtered by an Indonesian province/city (location) and seller type (shop_type: mall/power_shop). Each shop card has id, name, domain, url, location, tagline, description, favorite_count, is_gold, is_official, image, has_free_shipping and a short products preview (id/name/url/price/image). Returns up to `count` shops.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Search keyword (examples: "iphone", "sepatu"; minLength: 1)
• count integer required — Max number of shops to return (min: 1)
• location string nullable — Shop province or city filter (one of: "dki_jakarta", "jabodetabek", "bandung", "medan", "surabaya", "bali", "banten", "bengkulu", "di_aceh", "di_yogyakarta", "gorontalo", "jambi", "jawa_barat", "jawa_tengah", "jawa_timur", "kalimantan_barat", "kalimantan_selatan", "kalimantan_tengah", "kalimantan_timur", "kalimantan_utara", "kepulauan_bangka_belitung", "kepulauan_riau", "lampung", "maluku", "maluku_utara", "nusa_tenggara_barat", "nusa_tenggara_timur", "papua", "papua_barat", "riau", "sulawesi_barat", "sulawesi_selatan", "sulawesi_tengah", "sulawesi_tenggara", "sulawesi_utara", "sumatera_barat", "sumatera_selatan", "sumatera_utara", "kepulauan_seribu", "balikpapan", "banjar", "banjarbaru", "batam", "batu", "bau_bau", "bekasi", "bima", "binjai", "bitung", "blitar", "bogor", "bontang", "bukittinggi", "cilegon", "cimahi", "cirebon", "depok", "dumai", "gunungsitoli", "jakarta_barat", "jakarta_pusat", "jakarta_selatan", "jakarta_timur", "jakarta_utara", "kediri", "kotamobagu", "langsa", "lhokseumawe", "lubuk_linggau", "madiun", "magelang", "malang", "metro", "mojokerto", "padang_panjang", "padangsidimpuan", "pagar_alam", "palopo", "pare_pare", "pariaman", "pasuruan", "payakumbuh", "pekalongan", "pematang_siantar", "prabumulih", "probolinggo", "sabang", "salatiga", "sawahlunto", "sibolga", "singkawang", "solok", "sorong", "subulussalam", "sukabumi", "sungai_penuh", "surakarta", "tangerang", "tangerang_selatan", "tanjung_balai", "tarakan", "tasikmalaya", "tebing_tinggi", "tegal", "ternate", "tidore", "tidore_kepulauan", "tomohon", "tual", "denpasar_utara", "ambon", "banda_aceh", "bandar_lampung", "banjarmasin", "denpasar", "jayapura", "kendari", "kupang", "makassar", "manado", "mataram", "padang", "palangkaraya", "palembang", "palu", "pangkal_pinang", "pekanbaru", "pontianak", "samarinda", "semarang", "serang", "tanjung_pinang", "yogyakarta")
• shop_type string nullable — Seller type filter (one of: "mall", "power_shop")

Response

• @type string (default: "TokopediaShopCard")
• id string required
• name string nullable
• domain string nullable
• url string nullable
• location string nullable
• tagline string nullable
• description string nullable
• favorite_count integer nullable
• is_gold boolean nullable
• is_official boolean nullable
• image string nullable
• has_free_shipping boolean nullable
• products array (default: [])
  • @type string (default: "TokopediaShopPreviewProduct")
  • id string required
  • name string nullable
  • url string nullable
  • price number nullable
  • image string 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.