Overview
You send a Shopee product (shop_id, item_id, region) and get a job_id back immediately. Our infrastructure collects the product in parallel with other jobs, and you poll the job until it is completed. The finished job carries the product data under raw.
- Product page — one product: price, discount, every variant with its own price and stock, sold count, rating, shop details, shipping options, vouchers →
POST /jobs, thenGET /jobs/{job_id}. Send"raw_get_pc": true(recommended, used in every example here) to receive the complete product page — all 79 blocks in Shopee’s own layout, identical across the eight markets. - Listing page — the products shown on a search, category, brand, shop or collection page, up to 60 per page →
POST /cbc, thenGET /cbc/{job_id}. Full guide: Listings API.
Typical pipeline: walk a listing with /cbc to collect shop_id / item_id pairs, then fetch each product with /jobs. Both use the same API key and base URL.
Asynchronous by design
No request holds a connection open while Shopee is scraped, so throughput grows with the number of jobs you send in parallel.
Typical completion time
Measured median from submit to result: 10–20 s for Thailand, Indonesia and the Philippines; 25–50 s for Singapore, Vietnam, Malaysia and Brazil. Taiwan usually finishes within 1–3 minutes.
Charged only for answers
A job is charged only when it returns a definitive answer within its TTL. Our own failures and expired jobs are never charged.
Anti-bot handled
Sessions, proxies and blocking are managed on our side. You call a plain REST API with one key.
Quickstart
POST the product to /jobs. The response returns a job_id straight away.
GET /jobs/{job_id} every 3–5 seconds while status is pending or processing.
When status is completed, the full product page is under raw.get_pc.data, in Shopee’s own layout (see the sample response). result_status tells you whether the product is live, out of stock or unavailable.
# 1) submit curl -s -X POST https://shopee-multi-region.fastscraping.com/jobs \ -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" \ -d '{"shop_id":83276818,"item_id":23743605234,"region":"th","raw_get_pc":true,"ttl":600}' # 2) poll with the job_id from step 1 curl -s https://shopee-multi-region.fastscraping.com/jobs/JOB_ID -H "X-API-Key: YOUR_API_KEY"
import time, requests BASE = "https://shopee-multi-region.fastscraping.com" HEAD = {"X-API-Key": "YOUR_API_KEY"} def fetch_product(shop_id, item_id, region, ttl=600): job = requests.post(f"{BASE}/jobs", headers=HEAD, timeout=30, json={ "shop_id": shop_id, "item_id": item_id, "region": region, "raw_get_pc": True, "ttl": ttl}).json() deadline = time.time() + ttl + 30 # TTL plus the 20 s delivery grace while time.time() < deadline: r = requests.get(f"{BASE}/jobs/{job['job_id']}", headers=HEAD, timeout=30).json() if r["status"] not in ("pending", "processing"): return r # completed / failed / expired / not_found time.sleep(4) return None r = fetch_product(83276818, 23743605234, "th") print(r["result_status"], list(r.get("raw", {})))
const BASE = "https://shopee-multi-region.fastscraping.com"; const HEAD = { "X-API-Key": "YOUR_API_KEY", "Content-Type": "application/json" }; const sleep = (ms) => new Promise((r) => setTimeout(r, ms)); async function fetchProduct(shopId, itemId, region, ttl = 600) { const job = await (await fetch(`${BASE}/jobs`, { method: "POST", headers: HEAD, body: JSON.stringify({ shop_id: shopId, item_id: itemId, region, raw_get_pc: true, ttl }), })).json(); const deadline = Date.now() + (ttl + 30) * 1000; // TTL plus the 20 s delivery grace while (Date.now() < deadline) { const r = await (await fetch(`${BASE}/jobs/${job.job_id}`, { headers: HEAD })).json(); if (!["pending", "processing"].includes(r.status)) return r; await sleep(4000); } return null; }
Authentication
Every request needs your API key in the X-API-Key header. Authorization: Bearer YOUR_API_KEY is accepted as well.
X-API-Key: YOUR_API_KEY
A missing key returns 401 Missing API key; an unknown or disabled key returns 401 Invalid or inactive API key. Jobs are private to the key that created them.
Regions
Pass one of these codes as region. The blocks inside raw depend on the market; see Response data.
| Code | Market | Currency | Blocks in raw |
|---|---|---|---|
tw | Taiwan | TWD | get_pc — full product page payload |
br | Brazil | BRL | get_pc — full product page payload |
th | Thailand | THB | basic_pdp · get_pc · shop |
id | Indonesia | IDR | basic_pdp · get_pc · shop |
my | Malaysia | MYR | basic_pdp · get_pc · shop |
ph | Philippines | PHP | basic_pdp · get_pc · shop |
vn | Vietnam | VND | basic_pdp · get_pc · shop |
sg | Singapore | SGD | basic_pdp · get_pc · shop |
7386000 in Brazil is R$ 73.86; 999000000 in Thailand is ฿ 9,990.PDP — one product, the full page (raw_get_pc)
Three endpoints: submit a product with POST /jobs, poll GET /jobs/{job_id}, or read the latest cached data with GET /result. Every example in this part sends "raw_get_pc": true, so raw.get_pc.data is the complete product page in Shopee’s own layout — price, discount, every variant with stock and sold count, ratings, shop, shipping, vouchers — with the same shape in all eight markets. The sample response and field map close this part.
Submit a product job · POST /jobs
Creates one scrape job for one product and returns immediately, normally with status: "pending". Each call creates a new, separately charged job and runs a fresh scrape. One exception: a product we found delisted in the last few hours is answered at once as product_not_available, and the POST response then already shows status: "completed".
Request body
| Field | Type | Description |
|---|---|---|
shop_idrequired | integer | Shopee shop ID, the first number in shopee.xx/product/{shop_id}/{item_id}. |
item_idrequired | integer | Shopee item ID. |
regionrequired | string | Lowercase market code: tw, br, th, id, my, ph, vn or sg. Always send it: a request without region is not rejected but runs as Thailand (th). Upper-case codes such as "TH" return 400. |
ttloptional | integer | Seconds the job has to finish. Range 300–3600 (5 minutes to 1 hour): lower values become 300 and higher values become 3600. Omitted or 0 means the default, 3600. The effective value is echoed in the response note. See TTL & billing. |
all_voucheroptional | boolean or string | Taiwan. true, or one of "yes", "true", "1", "y", "on", also fetches the shop's vouchers into raw.get_pc.data.shop_vouchers. Not needed with raw_get_pc: it already includes the shop's vouchers. Other regions accept the flag without an error, but vouchers are not guaranteed there. |
raw_get_pcrecommendedoptional | boolean or string | Recommended for every integration — this is the format documented on this page. All eight markets. true (or "yes", "true", "1", "y", "on") returns the full product page in Shopee's own product-page layout: every block and every item field of the page, blocks that do not apply set to null, plus delivery options and fees, shop vouchers and shop details. See Full product page. Charged like any other job. |
POST /jobs
Content-Type: application/json
X-API-Key: YOUR_API_KEY
{
"shop_id": 1665239494,
"item_id": 58256703066,
"region": "br",
"raw_get_pc": true,
"ttl": 600
}
Response · 200
{
"job_id": "8aabc85bf7724eceaec27e5f375ad905",
"status": "pending",
"shop_id": 1665239494,
"item_id": 58256703066,
"note": "Poll GET /jobs/8aabc85bf7724eceaec27e5f375ad905 for your result. This job expires in 600s if not fetched in time."
}Possible errors: 400 unsupported region, 401 key problem, 422 a body that does not match the schema (for example a missing or non-integer shop_id), 429 rate, concurrency or quota limit. See Errors.
Get a product job · GET /jobs/{job_id}
Returns the job's state. While it runs you get the envelope without data; once it completes, the product data is added under raw.
Response fields
| Field | Type | Description |
|---|---|---|
job_id | string | The job you asked for. |
status | string | pending, processing, completed, failed, expired or not_found. See Job lifecycle. |
shop_id, item_id | integer | The product you submitted. |
result_status | string · null | What we found: success, out_of_stock, item_unavailable, product_not_available, shop_unavailable, failed, expired or not_found. null while the job runs. |
billable | boolean · null | Whether this job is charged. null while the job runs. |
retriable | boolean | true when submitting the same product again is worthwhile: the job was not charged, or (rarely) a completed job whose data failed our integrity check and was withheld. |
note | string · null | Free-text context, such as an internal retry, an expiry reason, or a notice that the data is no longer available. Informational only; it can be set in any status, so do not branch on it. |
voucher_source | string · null | For all_voucher jobs: live, cache or negative_cache (the shop has no vouchers). |
raw | object | The product data. With raw_get_pc it is { get_pc: { bff_meta, error, error_msg, data, http_status }, shop } where get_pc.data is the full product page — see the sample response and the field map. Present on completed jobs while the data is retained (see TTL & billing); absent once it has aged out or when our integrity check withheld it, and can be empty for product_not_available. See Response data. |
Completed jobs can also carry diagnostic fields such as http_status; they are safe to ignore.
{
"job_id": "8aabc85bf7724eceaec27e5f375ad905",
"status": "completed",
"shop_id": 1665239494,
"item_id": 58256703066,
"result_status": "success",
"billable": true,
"retriable": false,
"note": "",
"voucher_source": null,
"raw": {
"get_pc": {
"bff_meta": null, "error": 0, "error_msg": null,
"data": {
"item": {
"item_id": 58256703066, "shop_id": 1665239494,
"title": "Kit Mel Cola 1k Óleo Nutritivo Mel Natural 60 ml Trihair",
"currency": "BRL",
"price": 7386000, "price_before_discount": 7774000,
"stock": 409, "total_stock": 1213,
"historical_sold": 2609,
"tier_variations": [ { "name": "Quantidade", "options": ["Kit Mel Cola 1kg + Óleo 60ml"], … } ],
"models": [ { "model_id": 239439288108, "name": "Kit Mel Cola 1kg + Óleo 60ml", "stock": 1213, … } ],
…
},
"product_price": {
"price": { "single_value": 7386000, "range_min": -1, "range_max": -1 },
"price_before_discount": { "single_value": 7774000, … },
"discount": 5, …
},
"price_breakdown": {
"discount_breakdown": [ { "price_source": "Product Discount", "discount_amount": 388000, … } ], …
},
"product_review": {
"rating_star": 4.983, "rating_count": [1239, 1, 0, 5, 7, 1226],
"historical_sold": 2609, "liked_count": 2494, …
},
"shop_detailed": { "shopid": 1665239494, "name": "Cades Cosméticos - Loja Oficial", "rating_star": 4.886, … },
"product_images": { … }, "product_attributes": { … },
"product_description": { … }, "promotion_info": { … }
}
}
}
}
{
"job_id": "8aabc85bf7724eceaec27e5f375ad905",
"status": "pending",
"shop_id": 1665239494,
"item_id": 58256703066,
"result_status": null,
"billable": null,
"retriable": false,
"note": ""
}
{
"job_id": "3f1e0a9b27c84d0e9a5b1f6c2d7e8a90",
"status": "failed",
"shop_id": 1665239494,
"item_id": 58256703066,
"result_status": "shop_unavailable",
"billable": false,
"retriable": true,
"note": ""
}
Possible errors: 404 job not found, 403 not your job (the job belongs to another key), 401 key problem.
Latest result for a product
Returns the latest cached data for a product without a job_id. It works only for products your key already has a completed job for, and it reads the same product cache as GET /jobs/{job_id}: data is kept for 2 hours after the most recent completed scrape of that product. It is not charged.
Query parameters
| Parameter | Type | Description |
|---|---|---|
shop_idrequired | integer | Shopee shop ID. |
item_idrequired | integer | Shopee item ID. |
regionrequired | string | Lowercase market code, the same one you used when you submitted the job. If omitted, Thailand (th) is assumed. |
Response fields
| Field | Type | Description |
|---|---|---|
shop_id, item_id | integer | The product. |
status | string | The result for this product: success, out_of_stock, item_unavailable or product_not_available (the same values as result_status on a job). |
voucher_source | string · null | For all_voucher results: live, cache or negative_cache. |
raw | object | The product data, in the same format as the completed job (the raw_get_pc layout when the job was submitted with it). See the sample response and field map. |
curl -s "https://shopee-multi-region.fastscraping.com/result?shop_id=50662979&item_id=27037172806®ion=tw" \ -H "X-API-Key: YOUR_API_KEY" { "shop_id": 50662979, "item_id": 27037172806, "status": "success", "voucher_source": null, "raw": { "get_pc": { "bff_meta": null, "error": 0, "error_msg": null, "data": { "item": { "item_id": 27037172806, "shop_id": 50662979, "item_status": "normal", "status": 1, "item_type": 0, "reference_item_id": "", "title": "【蝦皮直營】御之味 棒棒餅 蔬菜口味/番茄口味 256g 蔬菜棒 番茄棒 棒棒餅乾 零食", "image": "sg-11134301-7ratq-macgjkhebpu81a", "label_ids": [ … 81 items ], "is_adult": false, "is_preview": false, "flag": 268632064, "is_service_by_shopee": true, "condition": 1, "cat_id": 100629, "has_low_fulfillment_rate": false, "is_live_streaming_price": null, "currency": "TWD", "brand": "御之味", "brand_id": 1099220, "show_discount": 25, "ctime": 1748940801, "item_rating": { … 1 keys }, "cb_option": 0, "has_model_with_available_shopee_stock": true, "shop_location": null, "attributes": null, "rich_text_description": { … 2 keys }, "invoice_option": null, "is_category_failed": null, "is_prescription_item": false, "preview_info": null, "show_prescription_feed": false, "is_alcohol_product": false, "is_infant_milk_formula_product": false, "is_unavailable": false, "is_partial_fulfilled": false, "is_presale": false, "is_presale_deposit_item": null, "is_presale_deposit_made": null, "description": "御之味 棒棒餅 蔬菜口味/番茄口味 256g\n\n\n\n御之味 棒棒餅 蔬菜口味/番茄口味 256g\n\n※產品特色:棒棒酥脆,內有16小包,純素可食\n\n※規格:256g/包\n\n※產地…", "categories": [ … 3 items ], "fe_categories": [ … 3 items ], "item_has_video": false, "presale_dday_start_time": null, "is_lowest_price_at_shopee": null, "display_description_disclosure_rsku_redirection": null, "display_similar_sold": null, "title_type": 1, "authorized_brand_name": null, "is_sexual": false, "models": [ … 2 items ], "tier_variations": [ … 1 items ], "size_chart": null, "size_chart_info": null, "welcome_package_type": null, "is_free_gift": false, "deep_discount": null, "is_low_price_eligible": null, "bundle_deal_info": null, "add_on_deal_info": null, "shipping_icon_type": 0, "badge_icon_type": 2, "spl_info": { … 7 keys }, "estimated_days": 1, "is_pre_order": false, "is_free_shipping": false, "overall_purchase_limit": null, "min_purchase_limit": 1, "is_hide_stock": false, "stock": 177, "normal_stock": null, "current_promotion_reserved_stock": null, "can_use_wholesale": false, "wholesale_tier_list": [], "price": 11200000, "raw_discount": 25, "hidden_price_display": null, "price_min": 11200000, "price_max": 11200000, "price_before_discount": 15000000, "price_min_before_discount": 15000000, "price_max_before_discount": 15000000, "other_stock": null, "discount_stock": null, "current_promotion_has_reserve_stock": false, "complaint_policy": null, "show_recycling_info": null, "should_show_amp_tag": true, "all_models_has_pre_order": null, "is_item_inherited": false, "max_quantity": null, "drug_details": null, "selected_real_models": null, "size_tier_variation_idx": null, "is_fashion_item": false, "social_proof_label": null, "title_tr": null, "description_tr": null, "rich_text_description_tr": null, "stock_display": null, "max_quantity_display": null, "disclaimer": null }, "shop": { … 14 keys }, "account": { … 5 keys }, "product_images": { … 22 keys }, "product_price": { "discount": null, "installment_info": { … 1 keys }, "spl_installment_info": null, "pack_size": "", "hide_price": false, "price": { … 4 keys }, "price_before_discount": { … 4 keys }, "presale_price": null, "lowest_past_price": null, "labels": null, "hide_discount": true, "discount_text": null, "show_final_price_indicator": true, "final_price_vouchers": [ … 1 items ], "has_final_price": true, "final_price_info": { … 6 keys }, "price_subtext": { … 5 keys }, "price_model": { … 3 keys }, "price_promotion": { … 6 keys }, "instalment_cta_action": { … 2 keys }, "spl_installment_banner": null, "show_non_logged_in_price_indicator": false }, "flash_sale": null, "flash_sale_booked": null, "flash_sale_preview": null, "deep_discount": null, "exclusive_price": null, "exclusive_price_cta": null, "welcome_package": null, "product_meta": { … 9 keys }, "product_review": { "rating_star": 4.979296066252588, "rating_count": [ … 6 items ], "total_rating_count": 966, "historical_sold": 2372, "global_sold": null, "liked": false, "liked_count": 226, "cmt_count": 966, "should_move_ratings_above": null, "review_rcmd_exp_group": null, "display_global_sold": false, "hide_rating": false, "hide_buyer_gallery": false, "hide_reviews": false, "hide_other_product_reviews_in_shop": false, "sold_count_disclosure": null, "historical_sold_display": "2,000+", "global_sold_display": "2,000+", "sold_count_display": "2,000+" }, "bottom_bar": { … 5 keys }, "promotion_info": { … 7 keys }, "presale_guide": null, "shipping_meta": { … 4 keys }, "product_preorder": null, "shopee_guarantee": null, "product_shipping": { … 18 keys }, "shop_vouchers_meta": null, "shop_vouchers": [ … 28 items ], "top_product": null, "mart_key_selling_point": null, "new_user_voucher": { … 6 keys }, "free_return": null, "clip_info": null, "age_gate": { … 2 keys }, "live_stream": null, "age_gate_control": null, "abnormal_popup": null, "return_on_spot": null, "tax_disclaimer": null, "price_with_variation_abtest_group": "Treatment4", "final_price_indicator": { … 4 keys }, "ongoing_banner": null, "teaser_banner": null, "price_breakdown": { … 3 keys }, "promotion_drawer": { … 5 keys }, "installment_drawer": { … 4 keys }, "alcohol_disclaimer": null, "size_guide": null, "designer_info": null, "shipping_info": null, "service_entrance": { … 1 keys }, "service_drawer": { … 1 keys }, "design_control": { … 27 keys }, "shopee_video_floating_window": null, "shopee_free_return": null, "lowest_price_indicator": null, "review": { … 9 keys }, "featured_videos": [ … 11 items ], "product_attributes": { … 5 keys }, "shop_detailed": { "shopid": 50662979, "userid": 50664367, "last_active_time": 1792396827, "vacation": false, "place": "桃園市楊梅區", "account": { … 3 keys }, "is_shopee_verified": false, "is_preferred_plus_seller": false, "is_official_shop": true, "shop_location": "桃園市楊梅區", "item_count": 32373, "rating_star": 4.962778, "response_rate": 100, "session_info": null, "name": "蝦皮直營 _ 生活超市 - 最快當日到", "ctime": 1514864597, "response_time": 1441, "follower_count": 2266627, "show_official_shop_label": true, "rating_bad": 78536, "rating_good": 40900516, "rating_normal": 184400, "session_infos": null, "status": 1, "is_individual_seller": null, "is_mart": false, "favorite_shop_info": null, "is_3pf": false, "sold_total": null, "is_shopee_choice": false, "is_high_end": false, "banner": { … 1 keys }, "authorized_brand": null, "is_scs": false, "shop_location_tr": null, "sold_total_display": null, "is_outlet": false, "display_fbs_logo": true, "is_chatroom_online": null, "outlet_shop": null, "vacation_status": null, "display_shopee_choice_tick": false, "is_smeter_shop": false, "is_pharmacy": false, "is_instant_mart": false, "fbs_display_type": 1 }, "retry_info": null, "vehicle_compatibility_info": null, "similar_cheaper_product": null, "membership_exclusive": null, "membership_exclusive_teaser": null, "trade_in": null, "product_description": { … 2 keys }, "size_info": null, "size_recommendation": null, "product_description_tr": null, "translation_status": 0, "selected_tiers": null, "pdp_page_type": 0, "floating_window_content": null, "size_display_info": null, "size_review_summary": null, "size_banner": null, "featured_voucher": { … 3 keys }, "bcrs_disclaimer": null, "description_summary": null, "top_banner": null, "bottom_banner": { … 7 keys }, "pre_purchase_signals": null, "featured_vouchers": null }, "http_status": 200 }, "shop": { … 57 keys } } }
Errors: 404 no completed job for this product on your key when your key has not requested this product yet; 404 no result yet (pending/failed/expired) when the cached data has aged out (submit a new job); 401 key problem; 422 missing or non-integer shop_id/item_id. Completed results may also carry diagnostic fields such as http_status; they are safe to ignore.
Sample response · raw_get_pc (full product page)
Send "raw_get_pc": true in POST /jobs to receive the whole product page in the same layout Shopee's app uses for it, in every market: tw, br, th, id, my, ph, vn and sg. The layout is identical across markets, so one parser covers all eight.
- Same keys as the product page.
raw.get_pcis{bff_meta, error, error_msg, data, http_status};datacarries all 79 page blocks anddata.itemall 103 item fields, in Shopee's order. A block that does not apply to the product (flash sale, live stream, size chart …) is present withnull. - What is filled: item and variants (
item.models[],item.tier_variations[], stock), prices and discounts (product_price,price_breakdown), delivery options with fees and delivery times (product_shipping), shop vouchers (data.shop_vouchers[]), shop details (shop_detailed, plusraw.shop), rating and sold counts (product_review), images and video (product_images), description (product_description) and categories. - Same request, more data. Submit, poll and charging work exactly as for a normal job; only the shape of
rawchanges. Without the flag you receive the older compact format (basic_pdp…) listed at the end of the field map; new integrations should always send"raw_get_pc": true.
POST /jobs
Content-Type: application/json
X-API-Key: YOUR_API_KEY
{
"shop_id": 138512957,
"item_id": 51215758080,
"region": "my",
"raw_get_pc": true,
"ttl": 600
}
The response, end to end · real Taiwan job
This is exactly what GET /jobs/{job_id} returns once a raw_get_pc job completes, taken from a real Taiwan job: the job envelope, then raw.get_pc.data with all 79 blocks in Shopee’s order (blocks that do not apply to this product are null), then raw.shop. Only long strings and long arrays are shortened here (… +N more); the untrimmed 318 KB file is linked below. Taiwan prices follow the same rule: 11200000 is NT$112.
{
"job_id": "59dd4105ebf64bf98e7bd4c7a1659d5a",
"status": "completed",
"shop_id": 50662979,
"item_id": 27037172806,
"result_status": "success",
"billable": true,
"retriable": false,
"note": "",
"http_status": {},
"raw": {
"get_pc": {
"bff_meta": null,
"error": 0,
"error_msg": null,
"data": {
"item": {
"item_id": 27037172806,
"shop_id": 50662979,
"item_status": "normal",
"status": 1,
"item_type": 0,
"reference_item_id": "",
"title": "【蝦皮直營】御之味 棒棒餅 蔬菜口味/番茄口味 256g 蔬菜棒 番茄棒 棒棒餅乾 零食",
"image": "sg-11134301-7ratq-macgjkhebpu81a",
"label_ids": [
16,
1838640,
… +79 more
],
"is_adult": false,
"is_preview": false,
"flag": 268632064,
"is_service_by_shopee": true,
"condition": 1,
"cat_id": 100629,
"has_low_fulfillment_rate": false,
"is_live_streaming_price": null,
"currency": "TWD",
"brand": "御之味",
"brand_id": 1099220,
"show_discount": 25,
"ctime": 1748940801,
"item_rating": { "rating_star": 4.979296066252588 },
"cb_option": 0,
"has_model_with_available_shopee_stock": true,
"shop_location": null,
"attributes": null,
"rich_text_description": {
"paragraph_list": [
… 58 items
],
"source_language": null
},
"invoice_option": null,
"is_category_failed": null,
"is_prescription_item": false,
"preview_info": null,
"show_prescription_feed": false,
"is_alcohol_product": false,
"is_infant_milk_formula_product": false,
"is_unavailable": false,
"is_partial_fulfilled": false,
"is_presale": false,
"is_presale_deposit_item": null,
"is_presale_deposit_made": null,
"description": "御之味 棒棒餅 蔬菜口味/番茄口味 256g\n\n\n\n御之味 棒棒餅 蔬菜口味/番茄口味 256g\n\n※產品特色:棒棒酥脆,內有16小包,純素可食\n\n※規格:256g/包\n\n※產地…",
"categories": [
{
"catid": 100629,
"display_name": "美食、伴手禮",
"no_sub": false,
"is_default_subcat": false
},
{
"catid": 100646,
"display_name": "休閒零食",
"no_sub": false,
"is_default_subcat": false
},
… +1 more
],
"fe_categories": [
{ … 4 keys },
{ … 4 keys },
… +1 more
],
"item_has_video": false,
"presale_dday_start_time": null,
"is_lowest_price_at_shopee": null,
"display_description_disclosure_rsku_redirection": null,
"display_similar_sold": null,
"title_type": 1,
"authorized_brand_name": null,
"is_sexual": false,
"models": [
{
"item_id": 27037172806,
"status": 1,
"current_promotion_reserved_stock": null,
"name": "蔬菜口味256g",
"promotion_id": 514803152465932,
"price": 11200000,
"price_stocks": [
{ … 3 keys },
{ … 3 keys }
],
"current_promotion_has_reserve_stock": false,
"normal_stock": null,
"extinfo": {
"tier_index": [
… 1 items
],
"is_pre_order": false,
"estimated_days": 1,
"sku_image": ""
},
"price_before_discount": 15000000,
"model_id": 270254108184,
"stock": 152,
"has_gimmick_tag": false,
… +7 more keys
},
{
"item_id": 27037172806,
"status": 1,
"current_promotion_reserved_stock": null,
"name": "番茄口味256g",
"promotion_id": 514803152465932,
"price": 11200000,
"price_stocks": [
{ … 3 keys },
{ … 3 keys }
],
"current_promotion_has_reserve_stock": false,
"normal_stock": null,
"extinfo": {
"tier_index": [
… 1 items
],
"is_pre_order": false,
"estimated_days": 1,
"sku_image": ""
},
"price_before_discount": 15000000,
"model_id": 270254108185,
"stock": 25,
"has_gimmick_tag": false,
… +7 more keys
}
],
"tier_variations": [
{
"name": "御之味棒棒餅",
"options": [
"蔬菜口味256g",
"番茄口味256g"
],
"images": null,
"properties": null,
"type": 0,
"summed_stocks": null,
"display_indicators": [
0,
0
],
"name_tr": null,
"options_tr": null,
"selling_points": [
"",
""
],
"selling_points_tr": null
}
],
"size_chart": null,
"size_chart_info": null,
"welcome_package_type": null,
"is_free_gift": false,
"deep_discount": null,
"is_low_price_eligible": null,
"bundle_deal_info": null,
"add_on_deal_info": null,
"shipping_icon_type": 0,
"badge_icon_type": 2,
"spl_info": {
"installment_info": null,
"user_credit_info": null,
"channel_id": null,
"show_spl": true,
"show_spl_lite": null,
"spl_xtra": null,
"spl_motorcycle_loan": null
},
"estimated_days": 1,
"is_pre_order": false,
"is_free_shipping": false,
"overall_purchase_limit": null,
"min_purchase_limit": 1,
"is_hide_stock": false,
"stock": 177,
"normal_stock": null,
"current_promotion_reserved_stock": null,
"can_use_wholesale": false,
"wholesale_tier_list": [],
"price": 11200000,
"raw_discount": 25,
"hidden_price_display": null,
"price_min": 11200000,
"price_max": 11200000,
"price_before_discount": 15000000,
"price_min_before_discount": 15000000,
"price_max_before_discount": 15000000,
"other_stock": null,
"discount_stock": null,
"current_promotion_has_reserve_stock": false,
"complaint_policy": null,
"show_recycling_info": null,
"should_show_amp_tag": true,
"all_models_has_pre_order": null,
"is_item_inherited": false,
"max_quantity": null,
"drug_details": null,
"selected_real_models": null,
"size_tier_variation_idx": null,
"is_fashion_item": false,
"social_proof_label": null,
"title_tr": null,
"description_tr": null,
"rich_text_description_tr": null,
"stock_display": null,
"max_quantity_display": null,
"disclaimer": null
},
"shop": { … 14 keys },
"account": { … 5 keys },
"product_images": {
"video": null,
"images": [
"sg-11134301-7ratq-macgjkhebpu81a",
"sg-11134301-7ratb-macgkj91oiog30",
… +1 more
],
"first_tier_variations": null,
"sorted_variation_image_index_list": [],
"overlay": {
"type": 0,
"image": "tw-11134258-81ztq-mi9z4zufebd241",
"preview_end_time": null,
"is_pre_order": null,
"description": ""
},
"makeup_preview": null,
"abnormal_status": "",
"promotion_images": [],
"long_images": null,
"shopee_video_info_list": null,
"shopee_video_rcmd_info": null,
"shopee_video_req_id": null,
"skincam": null,
"pdp_top_info_list": [
{
"pdp_top_video_info": null,
"pdp_top_image_info": { … 4 keys },
"content_source": 1,
"content_type": 2,
"content_size": 1,
"landing_path": "@shopee-rn/lucky-video--pdp-video-module/PDP_TOP_LANDING_PAGE",
"landing_params": [
… 1 items
]
},
{
"pdp_top_video_info": null,
"pdp_top_image_info": { … 4 keys },
"content_source": 1,
"content_type": 2,
"content_size": 1,
"landing_path": "@shopee-rn/lucky-video--pdp-video-module/PDP_TOP_LANDING_PAGE",
"landing_params": [
… 1 items
]
},
… +1 more
],
"has_long_image": false,
"show_find_similar": null,
"try_it_on": null,
"show_find_similar_for_selection": false,
"beautycam": null,
"unavailable_item_recommendation": null,
"models": null,
"gallery_contents": null
},
"product_price": {
"discount": null,
"installment_info": {
"recommended_plan": {
"months": 3,
"pay_per_month": 3533000,
"has_buyer_transaction_fee": true
}
},
"spl_installment_info": null,
"pack_size": "",
"hide_price": false,
"price": {
"single_value": 10600000,
"range_min": -1,
"range_max": -1,
"price_mask": null
},
"price_before_discount": {
"single_value": 15000000,
"range_min": -1,
"range_max": -1,
"price_mask": null
},
"presale_price": null,
"lowest_past_price": null,
"labels": null,
"hide_discount": true,
"discount_text": null,
"show_final_price_indicator": true,
"final_price_vouchers": [
{
"promotion_id": 1532427793760256,
"voucher_code": "SHOPCP002D",
"is_auto_claimed_just_now": null,
"groups": null,
"voucher_type": 2
}
],
"has_final_price": true,
"final_price_info": {
"model_id": 270254108184,
"hint_text": "券後價 >",
"show_final_price_indicator": true,
"final_price_vouchers": {
"platform_voucher": { … 6 keys },
"shop_voucher": null,
"ads_voucher": null
},
"payment_channel_discount": null,
"final_price_icon_type": 1
},
"price_subtext": {
"template": "{spaylater},低至 {amount} x {month}期",
"format": null,
"attributes": [
{ … 7 keys },
{ … 7 keys },
… +1 more
],
"text_color": null,
"text_hex_color": null
},
"price_model": {
"price_single_model_id": 270254108184,
"price_min_model_id": null,
"price_max_model_id": null
},
"price_promotion": {
"price_single_promotion_id": 514803152465932,
"price_single_promotion_type": 201,
"price_min_promotion_id": null,
"price_min_promotion_type": null,
"price_max_promotion_id": null,
"price_max_promotion_type": null
},
"instalment_cta_action": {
"type": 0,
"redirection_url": null
},
"spl_installment_banner": null,
"show_non_logged_in_price_indicator": false
},
"flash_sale": null,
"flash_sale_booked": null,
"flash_sale_preview": null,
"deep_discount": null,
"exclusive_price": null,
"exclusive_price_cta": null,
"welcome_package": null,
"product_meta": { … 9 keys },
"product_review": {
"rating_star": 4.979296066252588,
"rating_count": [
966,
1,
… +4 more
],
"total_rating_count": 966,
"historical_sold": 2372,
"global_sold": null,
"liked": false,
"liked_count": 226,
"cmt_count": 966,
"should_move_ratings_above": null,
"review_rcmd_exp_group": null,
"display_global_sold": false,
"hide_rating": false,
"hide_buyer_gallery": false,
"hide_reviews": false,
"hide_other_product_reviews_in_shop": false,
"sold_count_disclosure": null,
"historical_sold_display": "2,000+",
"global_sold_display": "2,000+",
"sold_count_display": "2,000+"
},
"bottom_bar": { … 5 keys },
"promotion_info": {
"spl": null,
"spl_lite": null,
"installment": null,
"wholesale": null,
"insurance": null,
"item_installment_eligibility": null,
"installment_simulation_entry": null
},
"presale_guide": null,
"shipping_meta": {
"show_fufilled_by_shopee": null,
"show_cod": null,
"show_mart": false,
"show_next_day_delivery": false
},
"product_preorder": null,
"shopee_guarantee": null,
"product_shipping": {
"free_shipping": {
"min_spend": {
"single_value": 6900000,
"range_min": -1,
"range_max": -1,
"price_mask": null
},
"has_fss": false
},
"shipping_fee_info": {
"ship_from_location": null,
"price": {
"single_value": -1,
"range_min": 0,
"range_max": 5500000,
"price_mask": null
},
"shipping_icon_type": 0,
"warning": null
},
"show_shipping_to": true,
"ungrouped_channel_infos": [
{
"channel_id": 30000002,
"name": "店取 - 最快當日到 [環保無包裝]",
"price": { … 4 keys },
"price_before_discount": { … 4 keys },
"channel_delivery_info": { … 15 keys },
"channel_promotion_infos": [],
"warning": null,
"shipping_icon_type": null,
"lowest_bpsf_promotion_rule": null,
"service_type_info": "",
"is_integrated_channel": true,
"late_delivery_compensation": { … 7 keys },
"is_sst_included": false,
"display_text": { … 4 keys },
… +8 more keys
},
{
"channel_id": 30000021,
"name": "宅配 - 最快隔日到",
"price": { … 4 keys },
"price_before_discount": null,
"channel_delivery_info": { … 15 keys },
"channel_promotion_infos": [
… 1 items
],
"warning": null,
"shipping_icon_type": null,
"lowest_bpsf_promotion_rule": null,
"service_type_info": "",
"is_integrated_channel": true,
"late_delivery_compensation": { … 7 keys },
"is_sst_included": false,
"display_text": { … 4 keys },
… +8 more keys
}
],
"grouped_channel_infos_by_service_type": [],
"also_available_channel_name": "",
"pre_selected_shipping_channel": {
"channel_id": 30000002,
"name": "店取 - 最快當日到 [環保無包裝]",
"price": {
"single_value": 0,
"range_min": -1,
"range_max": -1,
"price_mask": null
},
"price_before_discount": {
"single_value": 900000,
"range_min": -1,
"range_max": -1,
"price_mask": null
},
"channel_delivery_info": {
"has_edt": true,
"display_mode": "edt_by_date",
"estimated_delivery_date_from": 1792511999,
"estimated_delivery_date_to": 1792511999,
"estimated_delivery_time_min": 1,
"estimated_delivery_time_max": 1,
"delay_message": "",
"is_fastest_edt_channel": false,
"sla_message": "",
"show_edt": true,
"edt_text": "預計配達日 - 明天",
"formatted_edt_text": [
… 1 items
],
"formatted_pre_order_text": null,
"formatted_fbs_description_text": null,
… +1 more keys
},
"channel_promotion_infos": [],
"warning": {
"type": "",
"warning_msg": ""
},
"shipping_icon_type": null,
"lowest_bpsf_promotion_rule": null,
"service_type_info": "",
"is_integrated_channel": true,
"late_delivery_compensation": {
"type": 1,
"amount": 3000000,
"is_guaranteed_edt": true,
"compensation_amount": { … 1 keys },
"text": "",
"max_coins_cap": null,
"coin_cap": 0
},
"is_sst_included": false,
"display_text": {
"late_delivery_compensation": { … 6 keys },
"direct_delivery": null,
"fulfilled_by_shopee": null,
"spx_instant_delivery": null
},
"rule_type": 0,
"is_xdd_channel": false,
"show_shopee_plus_icon": false,
"xdd_value": 0,
"hide_shipping_fee": null,
"edt_tracking_info": null,
"subscription_icon": 0,
"sdv_available": false
},
"show_grouped_channel_first": false,
"is_item_with_price_range": false,
"also_available_channel_icon_type": null,
"pre_order_text": "",
"selected_late_delivery_compensation_for_drawer": null,
"shipping_info_text": {
"text_template": null,
"shipping_fee": null,
"edt_from": null,
"edt_to": null,
"show_shipping_fee_suffix": true,
"formatted_text": {
"edt": { … 5 keys },
"shipping_fee": { … 5 keys },
"late_delivery_compensation": { … 5 keys },
"fbs_description": null,
"display_edt_text_first_line": true,
"should_wrap_edt_text_by_attribute": false,
"scheduled_delivery_description": null
},
"highlight_free_shipping": false
},
"formatted_pre_order_text": null,
"has_free_return": false,
"model_id": 270254108184,
"delivery_address": {
"state": "臺北市",
"city": "中正區",
"district": null,
"town": null,
"zip_code": null,
"address": null,
"region": null,
"longitude": 121.5198716,
"latitude": 25.0421407,
"vn_data_version": null
},
"disable_shipping_drawer": null
},
"shop_vouchers_meta": null,
"shop_vouchers": [
{
"promotionid": 1532454369001472,
"voucher_code": "CPVX1019",
"signature": "9a9792606a8cb9579958449129d6ce0d9794e4684f90cbff16c60e7dc7445eff",
"use_type": 0,
"platform_type": null,
"voucher_market_type": 1,
"min_spend": 24900000,
"used_price": 1200000,
"current_spend": null,
"product_limit": true,
"quota_type": 1,
"percentage_claimed": 3,
"percentage_used": 31,
"start_time": 1792339200,
… +126 more keys
},
… +27 more
],
"top_product": null,
"mart_key_selling_point": null,
"new_user_voucher": { … 6 keys },
"free_return": null,
"clip_info": null,
"age_gate": { … 2 keys },
"live_stream": null,
"age_gate_control": null,
"abnormal_popup": null,
"return_on_spot": null,
"tax_disclaimer": null,
"price_with_variation_abtest_group": "Treatment4",
"final_price_indicator": { … 4 keys },
"ongoing_banner": null,
"teaser_banner": null,
"price_breakdown": {
"price": {
"single_value": 10600000,
"range_min": -1,
"range_max": -1,
"price_mask": null
},
"price_before_discount": {
"single_value": 15000000,
"range_min": -1,
"range_max": -1,
"price_mask": null
},
"discount_breakdown": [
{
"type": 0,
"price_source": "商品折扣",
"discount_amount": 3800000,
"exclusive_price": null,
"shop_voucher": null,
"platform_voucher": null,
"ads_voucher": null,
"breakdown_text": null,
"icon_type": null
},
{
"type": 3,
"price_source": "蝦皮優惠券",
"discount_amount": 600000,
"exclusive_price": null,
"shop_voucher": null,
"platform_voucher": { … 4 keys },
"ads_voucher": null,
"breakdown_text": { … 5 keys },
"icon_type": 0
}
]
},
"promotion_drawer": { … 5 keys },
"installment_drawer": { … 4 keys },
"alcohol_disclaimer": null,
"size_guide": null,
"designer_info": null,
"shipping_info": null,
"service_entrance": { … 1 keys },
"service_drawer": { … 1 keys },
"design_control": { … 27 keys },
"shopee_video_floating_window": null,
"shopee_free_return": null,
"lowest_price_indicator": null,
"review": { … 9 keys },
"featured_videos": [
… 11 items
],
"product_attributes": {
"attrs": [
{
"name": "商品數量",
"value": "尚有庫存",
"id": null,
"is_timestamp": null,
"brand_option": null,
"val_id": null,
"url": null,
"brand_id": null,
"full_url": null,
"type": 7,
"item_attribute_type": null,
"name_tr": null,
"value_tr": null
},
{
"name": "品牌",
"value": "御之味",
"id": null,
"is_timestamp": null,
"brand_option": null,
"val_id": null,
"url": "/search?attrId=1099220&brands=1099220&brandName=御之味",
"brand_id": 1099220,
"full_url": "https://shopee.tw/search?attrId=1099220&brands=1099220&brandName=御之味",
"type": 1,
"item_attribute_type": null,
"name_tr": null,
"value_tr": null
},
… +1 more
],
"categories": [
{
"catid": 11040483,
"display_name": "美食、伴手禮",
"no_sub": false,
"is_default_subcat": false
},
{
"catid": 11042031,
"display_name": "進口零食",
"no_sub": false,
"is_default_subcat": false
},
… +1 more
],
"related_items": [],
"upfront_attrs": [
{
"name": "商品數量",
"value": "尚有庫存",
"id": null,
"is_timestamp": null,
"brand_option": null,
"val_id": null,
"url": null,
"brand_id": null,
"full_url": null,
"type": 7,
"item_attribute_type": null,
"name_tr": null,
"value_tr": null
},
{
"name": "品牌",
"value": "御之味",
"id": null,
"is_timestamp": null,
"brand_option": null,
"val_id": null,
"url": "/search?attrId=1099220&brands=1099220&brandName=御之味",
"brand_id": 1099220,
"full_url": "https://shopee.tw/search?attrId=1099220&brands=1099220&brandName=御之味",
"type": 1,
"item_attribute_type": null,
"name_tr": null,
"value_tr": null
},
… +1 more
],
"fresh_featured_attrs": null
},
"shop_detailed": {
"shopid": 50662979,
"userid": 50664367,
"last_active_time": 1792396827,
"vacation": false,
"place": "桃園市楊梅區",
"account": {
"portrait": "tw-11134216-81ztj-mi5ka29amyv6d9",
"username": "shopee_choice_hl",
"status": 1
},
"is_shopee_verified": false,
"is_preferred_plus_seller": false,
"is_official_shop": true,
"shop_location": "桃園市楊梅區",
"item_count": 32373,
"rating_star": 4.962778,
"response_rate": 100,
"session_info": null,
"name": "蝦皮直營 _ 生活超市 - 最快當日到",
"ctime": 1514864597,
"response_time": 1441,
"follower_count": 2266627,
"show_official_shop_label": true,
"rating_bad": 78536,
"rating_good": 40900516,
"rating_normal": 184400,
"session_infos": null,
"status": 1,
"is_individual_seller": null,
"is_mart": false,
"favorite_shop_info": null,
"is_3pf": false,
"sold_total": null,
"is_shopee_choice": false,
"is_high_end": false,
"banner": { "shopee_choice": null },
"authorized_brand": null,
"is_scs": false,
"shop_location_tr": null,
"sold_total_display": null,
"is_outlet": false,
"display_fbs_logo": true,
"is_chatroom_online": null,
"outlet_shop": null,
"vacation_status": null,
"display_shopee_choice_tick": false,
"is_smeter_shop": false,
"is_pharmacy": false,
"is_instant_mart": false,
"fbs_display_type": 1
},
"retry_info": null,
"vehicle_compatibility_info": null,
"similar_cheaper_product": null,
"membership_exclusive": null,
"membership_exclusive_teaser": null,
"trade_in": null,
"product_description": {
"paragraph_list": [
{
"type": 0,
"text": "御之味 棒棒餅 蔬菜口味/番茄口味 256g",
"img_id": null,
"ratio": null,
"description_type": 1,
"empty_paragraph_count": null
},
{
"type": 10001,
"text": null,
"img_id": null,
"ratio": null,
"description_type": 1,
"empty_paragraph_count": 1
},
… +56 more
],
"source_language": ""
},
"size_info": null,
"size_recommendation": null,
"product_description_tr": null,
"translation_status": 0,
"selected_tiers": null,
"pdp_page_type": 0,
"floating_window_content": null,
"size_display_info": null,
"size_review_summary": null,
"size_banner": null,
"featured_voucher": { … 3 keys },
"bcrs_disclaimer": null,
"description_summary": null,
"top_banner": null,
"bottom_banner": { … 7 keys },
"pre_purchase_signals": null,
"featured_vouchers": null
},
"http_status": 200
},
"shop": {
"ctime": 1514864597,
"mtime": 1792396873,
"country": "TW",
"last_active_time": 1792396827,
"is_shopee_verified": false,
"is_official_shop": true,
"chat_disabled": false,
"disable_make_offer": 1,
"enable_display_unitno": false,
"cover": "tw-11134210-820lf-moul8yfpdg5p73",
"rating_normal": 184400,
"rating_bad": 78536,
"rating_good": 40900516,
"description": "「蝦皮直營 _ 生活超市 - 最快當日到」專營生活用品、衛生紙、家用清潔、食品飲料、母嬰用品、寵物、3C用品等人氣熱銷商品\n\n📢全館商品免運不用券,立即關注「蝦皮直營 _ 生活超…",
"is_semi_inactive": false,
"is_blocking_owner": false,
"preparation_time": 29209,
"cancellation_rate": 1,
"followed": false,
"vacation": false,
"show_low_fulfillment_warning": false,
"show_official_shop_label": true,
"show_official_shop_label_in_title": true,
"show_shopee_verified_label": false,
"real_url_if_matching_custom_url": "",
"status": 1,
"cb_option": 0,
"has_decoration": true,
"shop_location": "桃園市楊梅區",
"rating_star": 4.962778,
"show_live_tab": true,
"has_flash_sale": true,
"userid": 50664367,
"shopid": 50662979,
"name": "蝦皮直營 _ 生活超市 - 最快當日到",
"item_count": 32373,
"follower_count": 2266627,
"response_rate": 100,
"response_time": 1441,
"account": { … 11 keys },
"has_shopee_flash_sale": true,
"has_in_shop_flash_sale": false,
"has_brand_sale": true,
"is_preferred_plus_seller": false,
"show_new_arrival_items": true,
"new_arrival_items_start_ts": 1789833600,
"visibility": 0,
"warning": 10,
"default_landing": "control",
"latest_item_ctime": 1791964165,
"has_join_membership": false,
"ab_test_info": { … 61 keys },
"show_membership_tab": true,
"show_video_entry": false,
"video_entry_info": "",
"campaign_hot_deal_discount_min": 15,
"video_rn_jump_url": ""
}
}
}Download the complete response (Taiwan, JSON, 318 KB) — the same body untrimmed, so a parser can be written and tested against every field before you send a single job.
All 79 blocks in raw.get_pc.data
Every block is always present, so your parser never meets a missing key. For the product above, 31 blocks are filled: item, shop, account, product_images, product_price, product_meta, product_review, bottom_bar, promotion_info, shipping_meta, product_shipping, shop_vouchers, new_user_voucher, age_gate, price_with_variation_abtest_group, final_price_indicator, price_breakdown, promotion_drawer, installment_drawer, service_entrance, service_drawer, design_control, review, featured_videos, product_attributes, shop_detailed, product_description, translation_status, pdp_page_type, featured_voucher, bottom_banner.
The other 48 are null because they do not apply to this product (no flash sale, no live stream, no size guide …): flash_sale, flash_sale_booked, flash_sale_preview, deep_discount, exclusive_price, exclusive_price_cta, welcome_package, presale_guide, product_preorder, shopee_guarantee, shop_vouchers_meta, top_product, mart_key_selling_point, free_return, clip_info, live_stream, age_gate_control, abnormal_popup, return_on_spot, tax_disclaimer, ongoing_banner, teaser_banner, alcohol_disclaimer, size_guide, designer_info, shipping_info, shopee_video_floating_window, shopee_free_return, lowest_price_indicator, retry_info, vehicle_compatibility_info, similar_cheaper_product, membership_exclusive, membership_exclusive_teaser, trade_in, size_info, size_recommendation, product_description_tr, selected_tiers, floating_window_content, size_display_info, size_review_summary, size_banner, bcrs_disclaimer, description_summary, top_banner, pre_purchase_signals, featured_vouchers.
1490000 is RM 14.90).Field map · where each data point lives in raw
Where to find the common data points in raw. Field names follow Shopee's format. A value that is not available for a product comes back as 0, an empty string or null; treat those as not available. Numbers inside basic_pdp can arrive as JSON strings.
"raw_get_pc": true every market returns the same layout, so the first table applies to all eight markets. The second table only describes legacy jobs sent without the flag.All markets with raw_get_pc · raw.get_pc.data
| Data point | Path |
|---|---|
| Title | item.title |
| Current price | product_price.price.single_value, also item.price |
| Price before discount | product_price.price_before_discount.single_value |
| Discount % | product_price.discount |
| Discount breakdown | price_breakdown.discount_breakdown[] |
| Stock | item.total_stock (sum across all variants). item.stock can be a smaller promotion allocation. |
| Variants and SKUs | item.models[] (model_id, name, stock), item.tier_variations[]. models[].price is not always the price a buyer pays; use product_price for the current price. |
| Sold count | product_review.historical_sold, product_review.global_sold |
| Rating | product_review.rating_star; product_review.rating_count = [total, 1★, 2★, 3★, 4★, 5★] |
| Likes | product_review.liked_count |
| Images and video | product_images |
| Categories and attributes | item.categories[] (category IDs; display_name is empty), product_attributes.attrs (can be empty) |
| Description | product_description.paragraph_list |
| Shop | shop_detailed (shopid, name, rating_star, is_official_shop, is_shopee_verified). Counters such as follower_count and item_count are not filled in this block. |
Shop vouchers (Taiwan, all_voucher) | shop_vouchers[] (voucher_code, min_spend, start_time, end_time …) |
Legacy compact format (jobs sent without raw_get_pc) · Thailand, Indonesia, Malaysia, Philippines, Vietnam, Singapore
| Data point | Path |
|---|---|
| Title | raw.basic_pdp.name |
| Current price | raw.get_pc.data.item.price (range: price_min, price_max), including running promotions. raw.basic_pdp.price_min/price_max leave promotions out and can be higher. |
| Price before discount | raw.get_pc.data.item.price_before_discount; also raw.basic_pdp.normal_price_min, normal_price_max |
| Discount % | raw.get_pc.data.item.show_discount |
| Stock | raw.basic_pdp.total_stock (a string, e.g. "311") |
| Variants and SKUs | raw.basic_pdp.models[] (model_id, name, price, normal_price, stock, sold), tier_variations[] |
| Sold count | raw.basic_pdp.sold |
| Rating | raw.basic_pdp.rating.rating_star; rating.rating_counts = [0, 1★, 2★, 3★, 4★, 5★] (index 0 is not the total) |
| Likes and comments | raw.basic_pdp.liked_count, cmt_count |
| Images and description | raw.basic_pdp.images (Shopee image IDs). Plain-text description: raw.get_pc.data.item.description; raw.basic_pdp.description is a JSON-encoded list of text and image segments. |
| Page item summary | raw.get_pc.data.item (title, categories, item_rating, tier_variations …) |
| Shop | raw.shop (name, rating_star, follower_count, response_rate, shop_location, item_count …) |
{
"basic_pdp": {
"item_id": "23743605234", "shop_id": "83276818", "currency": "THB",
"price_min": "1089000000", "price_max": "1089000000",
"total_stock": "311", "sold": 4266,
"rating": { "rating_star": 4.71, "rating_counts": [0, 52, 20, 55, 119, 1477] },
"models": [ { "model_id": "186771150146", "price": "1089000000", "normal_price": "1749000000", "stock": 311, "sold": 4266, … } ],
…
},
"get_pc": { "data": { "item": { "price": 999000000, "price_before_discount": 1749000000, "show_discount": 43, … } } },
"shop": { "shopid": 83276818, "name": "samsung_thailand", "rating_star": 4.89, "follower_count": 1628625, "response_rate": 97, … }
}CBC — search, category, brand, shop and collection pages
Two endpoints: POST /cbc submits one listing page (up to 60 products with price, sold count and rating), GET /cbc/{job_id} returns it together with next_page_url to walk the listing. Use it to collect shop_id / item_id pairs, then fetch each product with Part 1. Full reference: Listings API.
Submit a listing job · POST /cbc
Fetches one page of a Shopee listing (a category, a search, a brand filter, a shop or a collection) exactly as the website shows it. You send the listing URL as it appears in your browser, with its sort order and filters, and get a job_id back immediately. Poll GET /cbc/{job_id} until the job is completed; the products are then under items.
- One request is one listing page of up to 60 products, the same page size as the website.
- Pages are 0-based, like the website: the
pagequery parameter in the URL picks the page, and a URL withoutpageis page 0. - Full reference: every URL type, filter and field is described in the Shopee Listing API docs.
- Same key, same model. The
X-API-Keyheader, the submit-then-poll flow and the per-key rate limits are the same as for POST /jobs.
Request body
| Field | Type | Description |
|---|---|---|
urlrequired | string | A Shopee web listing URL, copied from the browser. See the supported URL types and filters below. |
regionoptional | string | Lowercase market code. It is taken from the URL host, so you can leave it out; if you send it, it must match the host (br for shopee.com.br, and so on). |
slimoptional | boolean | true returns compact, uniform product rows instead of the full Shopee listing cards. Default false. See Products in items. |
Any other field in the body is rejected with 422.
Supported URLs
| Listing | URL form | kind |
|---|---|---|
| Category | /<slug>-cat.<id>, also with sub-categories: -cat.<id>.<id>… | category |
| Search | /search?keyword=…, and/or brands=<id>[,<id>] | search |
| Brand | /search?brands=<id>, optionally with keyword= | search |
| Shop | /<shop-username> or /shop/<shopid>, optionally with searchKeyword= to search inside the shop | shop |
| Collection | /collections/<id> | collection |
All eight markets are supported. The market comes from the URL host:
| Host | Region | Host | Region |
|---|---|---|---|
shopee.tw | Taiwan · tw | shopee.com.my | Malaysia · my |
shopee.com.br | Brazil · br | shopee.ph | Philippines · ph |
shopee.co.th | Thailand · th | shopee.sg | Singapore · sg |
shopee.co.id | Indonesia · id | shopee.vn | Vietnam · vn |
Any other host returns 400, and so do pages that are not listings or not supported yet: product pages (…-i.<shopid>.<itemid>), short or share links, and Shopee Mall pages (/mall/…). Send the normal page URL from the browser.
Sort and filters
Use the website's own query parameters. The simplest way is to apply the sort and filters on the website and copy the resulting URL.
| Parameter | Description |
|---|---|
sortBy, order | sortBy is relevancy, pop, sales, ctime (newest) or price; order is asc or desc (default desc). Without sortBy, shop pages sort by pop and all other listings by relevancy, as on the website. |
minPrice, maxPrice | Price range in whole local-currency units (no decimals), written without thousands separators: for example minPrice=5&maxPrice=30 in Brazil or minPrice=50000 in Vietnam. |
brands | One brand ID or several, comma-separated. /search URLs only. |
keyword | Search term on /search URLs. Not allowed on category or collection URLs. |
searchKeyword | Search term inside a shop. |
ratingFilter | Minimum star rating, 1–5. |
locations | Shop location names exactly as the website of that market writes them, comma-separated. A name the website does not use returns no products. |
withDiscount | true keeps only discounted products. |
fe_filter_options | The website's filter list. Supported groups: LOCATIONS, RATING, CONDITION (NEW_ITEM, USED_ITEM), SERVICE_AND_PROMOTION (WITH_DISCOUNT) and PRICE_RANGE. |
page | 0-based page number. Default 0. |
400 naming the parameter, so you never get (or pay for) a broader listing than the one you asked for. Tracking parameters such as utm_*, gclid, fbclid, entryPoint, tab, itemidlist and the #fragment are ignored. One exception: Shopee does not apply CONDITION on collection pages, so such a job still runs and its warnings say the results are not filtered by condition.How deep a listing goes
Shopee serves up to about 1,020 products for a listing (17 pages), or 500 (9 pages) when sorted by sales, price or newest. total_pages in the response already reflects these limits, so you can use it directly. total_count is Shopee's own figure and can be larger than what is reachable. The limits below are the ones Shopee applies today; Shopee sets them, and if a listing serves fewer products, the extra page completes with 0 products and is not charged.
sortBy | Products reachable | Pages |
|---|---|---|
sales, price, ctime | 500 | 0–8 |
pop, relevancy | about 1,000 | 0–16 |
A page beyond the reachable range completes with 0 products and is not charged. To cover more of a large category, split it with filters (price ranges, sub-categories, locations) rather than going deeper.
Walking a listing
Each page is its own job. When a job completes, has_more, next_page and next_page_url tell you how to continue: submit next_page_url (the same URL with page=N+1) as a new job, and stop when has_more is false. A listing can shift between requests, so de-duplicate products by itemid.
# 1) submit page 0 of a listing curl -s -X POST https://shopee-multi-region.fastscraping.com/cbc \ -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" \ -d '{"url":"https://shopee.com.br/search?keyword=kit%20mel%20cola&sortBy=sales","slim":true}' # 2) poll with the job_id from step 1 curl -s https://shopee-multi-region.fastscraping.com/cbc/JOB_ID -H "X-API-Key: YOUR_API_KEY" # 3) when completed and has_more is true, submit next_page_url as a new job curl -s -X POST https://shopee-multi-region.fastscraping.com/cbc \ -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" \ -d '{"url":"https://shopee.com.br/search?keyword=kit%20mel%20cola&sortBy=sales&page=1","slim":true}'
import time, requests BASE = "https://shopee-multi-region.fastscraping.com" HEAD = {"X-API-Key": "YOUR_API_KEY"} def fetch_page(url, slim=True, timeout_s=900): job = requests.post(f"{BASE}/cbc", headers=HEAD, timeout=30, json={"url": url, "slim": slim}) job.raise_for_status() # 400 names an unsupported URL or filter job_id = job.json()["job_id"] deadline = time.time() + timeout_s while time.time() < deadline: r = requests.get(f"{BASE}/cbc/{job_id}", headers=HEAD, timeout=30).json() if r["status"] in ("completed", "failed"): return r time.sleep(4) return None def walk_listing(url, slim=True): seen, products = set(), [] while url: r = fetch_page(url, slim) if not r or r["status"] != "completed": break # r["error"] says why; re-submit the same URL later for p in r["items"]: if p["itemid"] not in seen: # slim rows; full cards: itemid sits in item_basic or item_data seen.add(p["itemid"]); products.append(p) url = r["next_page_url"] if r["has_more"] else None return products rows = walk_listing("https://shopee.com.br/search?keyword=kit%20mel%20cola&sortBy=sales") print(len(rows), rows[0]["name"] if rows else None)
const BASE = "https://shopee-multi-region.fastscraping.com"; const HEAD = { "X-API-Key": "YOUR_API_KEY", "Content-Type": "application/json" }; const sleep = (ms) => new Promise((r) => setTimeout(r, ms)); async function fetchPage(url, slim = true, timeoutS = 900) { const res = await fetch(`${BASE}/cbc`, { method: "POST", headers: HEAD, body: JSON.stringify({ url, slim }) }); if (!res.ok) throw new Error((await res.json()).detail); // 400 names an unsupported URL or filter const { job_id } = await res.json(); const deadline = Date.now() + timeoutS * 1000; while (Date.now() < deadline) { const r = await (await fetch(`${BASE}/cbc/${job_id}`, { headers: HEAD })).json(); if (["completed", "failed"].includes(r.status)) return r; await sleep(4000); } return null; } async function walkListing(url, slim = true) { const seen = new Set(), products = []; while (url) { const r = await fetchPage(url, slim); if (!r || r.status !== "completed") break; // r.error says why; re-submit the same URL later for (const p of r.items) if (!seen.has(p.itemid)) { seen.add(p.itemid); products.push(p); } url = r.has_more ? r.next_page_url : null; } return products; }
Response · 200
The POST returns the job with status: "pending", in the same shape as GET /cbc/{job_id}; result fields stay null (counts 0) until the job finishes.
{
"job_id": "5c0f7e2a9b1d4e6f8a3c2b1d0e9f8a7b",
"status": "pending",
"region": "br",
"url": "https://shopee.com.br/search?keyword=kit%20mel%20cola&sortBy=sales",
"page": 0,
"slim": true,
"kind": "search",
"created_ts": 1791190812,
"attempts": 0,
"pages_fetched": 0, "items_returned": 0, "total_count": null, "total_pages": null,
"has_more": null, "next_page": null, "next_page_url": null,
"stop": null, "card_shape": null, "billable_pages": 0, "billing_error": null,
"elapsed_s": null, "error": null, "warnings": null,
"note": "Poll GET /cbc/5c0f7e2a9b1d4e6f8a3c2b1d0e9f8a7b until status is 'completed' or 'failed' …"
}Possible errors: 400 not a Shopee listing URL, unsupported host, unsupported filter, a search URL without keyword or brands, or an invalid page (the message names the problem); 401 key problem; 422 an unknown field in the body; 429 a per-key limit. See Errors.
Get a listing job · GET /cbc/{job_id}
Returns the listing job. Poll every 3–5 seconds while status is pending or processing. If a page fails temporarily on our side, it is retried automatically and the job stays pending or processing meanwhile, which can take a few minutes; after repeated failures it ends as failed with the reason in error, and you can submit the URL again.
Response fields
| Field | Type | Description |
|---|---|---|
job_id | string | The job you asked for. |
status | string | pending, processing, completed or failed. |
region, url, slim | string · boolean | What you submitted; region as taken from the URL host. |
page | integer | The 0-based page this job fetches. |
kind | string | category, search, shop or collection. |
created_ts | number | Unix timestamp in seconds. |
attempts | integer | Automatic retries so far. Informational. |
items_returned | integer | Products on this page, 0–60. |
pages_fetched | integer | 1 when the page was read; 0 for a page beyond the reachable range. |
total_count | integer · null | Shopee's total for the listing. Can be larger than what Shopee lets you reach. |
total_pages | integer · null | Pages you can actually fetch for this URL and sort, already capped (see How deep a listing goes). |
has_more | boolean · null | true when another page follows. Stop when it is false. |
next_page, next_page_url | integer · string · null | The next page number, and your URL with page set to it. Submit next_page_url as a new job. |
stop | string · null | Why this job stopped reading, such as max_pages (more pages follow), total_reached, nomore or end_of_range. Informational; branch on has_more. |
card_shape | string · null | item_basic or item_data: the shape of the full cards in items. null when the page has no products. |
billable_pages | integer | Pages charged for this job: 1 for a completed page with products, otherwise 0. It can read 0 for a moment right after the job completes. |
billing_error | boolean · null | true only if recording the charge failed on our side; it is reconciled later. Safe to ignore. |
elapsed_s | number · null | Seconds spent fetching the page. |
error | string · null | Reason for a failed job. |
warnings | array · null | Notices about the request, for example a filter Shopee does not apply on this listing type. |
note | string · null | Free-text context. Informational only; do not branch on it. |
items | array | The products, in listing order. Present only on completed jobs while the result is retained. |
Products in items
By default items holds the Shopee listing cards exactly as Shopee returns them, in one of two shapes. Category and search pages use item_basic cards; shop pages use item_data cards with the name, image and location in item_card_displayed_asset; collection pages can come back in either shape. Always read card_shape instead of inferring the shape from the URL.
card_shape | Card |
|---|---|
item_basic | { "item_basic": { "itemid", "shopid", "name", "price", "historical_sold", "item_rating", … } } |
item_data | { "item_data": { "itemid", "shopid", "price", … }, "item_card_displayed_asset": { "name", "image", … } } |
With slim: true, every page returns the same compact row, whatever the card shape: itemid, shopid, name, price, price_before_discount, historical_sold, sold, monthly_sold, display_sold_count, rating_star, catid, brand, shop_location, image, ctime and item_status. A value Shopee does not provide on a card is null.
7386000 in Brazil is R$ 73.86. Prices in Indonesia and Vietnam run into the billions, so store them as 64-bit integers.{
"job_id": "5c0f7e2a9b1d4e6f8a3c2b1d0e9f8a7b",
"status": "completed",
"region": "br",
"url": "https://shopee.com.br/search?keyword=kit%20mel%20cola&sortBy=sales",
"page": 0,
"slim": false,
"kind": "search",
"created_ts": 1791190812,
"attempts": 0,
"pages_fetched": 1,
"items_returned": 60,
"total_count": 1183,
"total_pages": 9,
"has_more": true,
"next_page": 1,
"next_page_url": "https://shopee.com.br/search?keyword=kit%20mel%20cola&sortBy=sales&page=1",
"stop": "max_pages",
"card_shape": "item_basic",
"billable_pages": 1,
"billing_error": false,
"elapsed_s": 3.8,
"error": null,
"warnings": null,
"note": null,
"items": [
{
"item_basic": {
"itemid": 58256703066, "shopid": 1665239494,
"name": "Kit Mel Cola 1k Óleo Nutritivo Mel Natural 60 ml Trihair",
"currency": "BRL",
"price": 7386000, "price_before_discount": 7774000,
"historical_sold": 2609, "sold": 312,
"item_rating": { "rating_star": 4.983, … },
"shop_location": "São Paulo", "item_status": "normal",
…
},
…
},
… 59 more cards
]
}
{
"job_id": "5c0f7e2a9b1d4e6f8a3c2b1d0e9f8a7b",
"status": "completed",
"slim": true,
"page": 0, "total_pages": 9, "has_more": true, "next_page": 1,
… same envelope as the full response
"items": [
{
"itemid": 58256703066, "shopid": 1665239494,
"name": "Kit Mel Cola 1k Óleo Nutritivo Mel Natural 60 ml Trihair",
"price": 7386000, "price_before_discount": 7774000,
"historical_sold": 2609, "sold": 312, "monthly_sold": 300, "display_sold_count": 2609,
"rating_star": 4.983, "catid": 100630, "brand": "Trihair",
"shop_location": "São Paulo", "image": "br-11134207-…",
"ctime": 1718035200, "item_status": "normal"
},
…
]
}
{
"job_id": "5c0f7e2a9b1d4e6f8a3c2b1d0e9f8a7b",
"status": "processing",
"region": "br",
"page": 0,
"kind": "search",
"attempts": 0,
"items_returned": null, "has_more": null, "next_page_url": null,
… no items until completed
}
Billing and retention
- One charge per completed page that returned products. Empty pages, pages beyond the end of the listing and failed jobs are not charged.
- Products are kept for 2 hours after the job completes; the job status, counts and paging fields for 24 hours. After that,
404. - Each page is a new job, so re-submitting the same URL fetches it again and is charged again.
Possible errors: 404 unknown or expired job, 403 the job belongs to another key, 401 key problem.
Usage, job history and health
Read your credits, daily usage and recent jobs for the key you call with. Not charged.
Usage
Your key's limits, remaining credits, job counts and charged usage per region. interval (1–365, default 30) sets how many days daily covers; values outside that range return 422. Day buckets in totals, daily and monthly_breakdown follow the server's reporting day (Central European Time).
In monthly_breakdown, a month with no usage is null and a day with no usage is 0 instead of an object. jobs.total also counts processing and expired jobs.
{
"owner": "your-company",
"timezone": "UTC",
"key": { "is_active": true, "created_at": "2026-09-25T10:20:20" },
"limits": { "per_minute": 120, "per_hour": 1200, "per_day": 1000, "concurrency": 100 },
"credits": { "total": 1000, "used": 37, "remaining": 963, "unlimited": false },
"jobs": { "total": 41, "completed": 37, "failed": 1, "pending": 3, "not_found": 0, "billable": 37 },
"totals": {
"today": { "all": 12, "th": 9, "tw": 3 },
"yesterday": { "all": 25, "br": 25 },
… day_before_yesterday, last_7_days, last_30_days, this_month, last_month, this_year, lifetime
},
"daily": [ { "date": "2026-09-25", "th": 9, "tw": 3, "all": 12 }, … ],
"monthly_breakdown": { "2026-09": { "24": { "th": 9, "all": 9 }, "25": 0, …, "total": 37 }, "2026-08": null }
}Job history
Your jobs, newest first. limit is 1–500 (default 50); use offset to page. Out-of-range values return 422. created_ts is a Unix timestamp in seconds.
{
"limit": 2, "offset": 0,
"items": [
{ "job_id": "a32d719e27744a1393722737e9209506", "region": "tw", "shop_id": 5597991, "item_id": 74412812,
"status": "completed", "result_status": "success", "billable": true, "created_ts": 1790228814.34 },
{ "job_id": "8daf6d5a0e834572b0a0221e0089bbe8", "region": "tw", "shop_id": 37004578, "item_id": 7775080780,
"status": "completed", "result_status": "success", "billable": true, "created_ts": 1790227317.52 }
]
}Health
Returns HTTP 200 with "status": "ok" while the API is up. Use it for uptime monitoring.
How jobs run, how they are charged, and the limits
Status lifecycle, TTL and billing rules, per-key rate limits, error codes and best practices — they apply to both the product page and the listing APIs.
Job lifecycle
A job normally moves from pending to processing and ends in one of four final states. It can go back from processing to pending while we retry it internally, and it can end without reaching processing (expired in the queue, or answered at once for a recently delisted product). Poll until status is no longer pending or processing.
status | result_status | Meaning | Charged | Retry |
|---|---|---|---|---|
completed | success | Live product; full data in raw. | yes | no |
completed | out_of_stock | The product exists but has no stock. Data is still returned. | yes | no |
completed | item_unavailable | The listing exists but cannot be bought right now. | yes | no |
completed | product_not_available | Delisted, banned or deleted on Shopee. raw can be partial or empty. | yes | no |
failed | shop_unavailable, failed | We could not complete the scrape. | no | yes |
expired | expired | The job did not finish in time: its TTL ran out, or it could not be processed after repeated internal retries. | no | yes |
not_found | not_found | Shopee does not recognise this shop and item pair. | no | no |
Use the billable and retriable flags in your code rather than hard-coding this table; they are computed per job and always reflect the final decision.
TTL & billing
- TTL is the time a job has to finish: 300 to 3600 seconds, default 3600.
- A job is charged once when it completes with
billable: truewithin its TTL or the 20-second grace after it. One job is one charge, whatever the size of the product data. - A job that has not completed by its TTL plus the 20-second grace becomes
expiredand is not charged. Keep polling until about TTL + 30 seconds before giving up. - Product data is kept for 2 hours after the most recent completed scrape of that product. It is stored per product, so if the same product is scraped again in that time, an earlier job returns the newer data under
raw. After that the envelope still shows the final status and billing, with a note that the data is no longer available. - Submitting the same product again creates a new job, charged separately (see Submit a job for the delisted-product exception).
- Listings (POST /cbc) are charged per page: one charge for each completed page that returned products. Empty pages, pages beyond the end of a listing and failed listing jobs are not charged. Listing products are kept for 2 hours after the job completes and the job itself for 24 hours.
Rate limits
Each API key has its own limits, checked when you submit a job (POST /jobs) or a listing job (POST /cbc). Polling and the /me endpoints are not limited. When a limit is reached, the submit returns 429 with a message naming it. Charged listing pages count towards the per-minute, per-hour, per-day and quota limits like charged product results; the concurrency limit applies to POST /jobs only.
| Limit | What it counts | 429 message |
|---|---|---|
| Concurrency | Your jobs currently pending or processing | Concurrency limit reached (N in-flight jobs) |
| Per minute, hour, day | Charged results in the last minute, the last hour, or since 00:00 UTC | Rate limit exceeded (per-minute), (per-hour), (per-day) |
| Total quota | Charged results over the key's lifetime (trial keys) | Quota exceeded (lifetime) |
GET /me/usage always shows the limits on your key. The per-minute, per-hour, per-day and quota limits compare results already charged, so jobs you have in flight still run and are charged; the charged total can pass a limit by up to your in-flight jobs. Counters refresh every few seconds.
Errors
Errors return a JSON body with a detail field.
HTTP/1.1 429 Too Many Requests
{ "detail": "Concurrency limit reached (100 in-flight jobs)" }| Code | detail | What to do |
|---|---|---|
| 400 | Unsupported region 'xx'. Supported: [...] | Use one of the region codes. |
| 400 | Listing URL message, for example unsupported filter param(s): … | POST /cbc: the URL is not a supported Shopee listing, its host is not one of the eight markets, a search URL has neither keyword nor brands, page is invalid, or a filter is not supported. The message names the parameter; remove or change it. |
| 401 | Missing API key, Invalid or inactive API key | Send a valid key in X-API-Key. |
| 403 | not your job | Read the job with the key that created it. |
| 404 | job not found | Check the job_id. |
| 404 | no completed job for this product on your key | GET /result only serves products your key has a completed job for. Submit a job first. |
| 422 | Validation details (a list) | The request did not match the schema: a missing or non-integer shop_id/item_id, a non-integer ttl, a body that is not JSON, or a query parameter out of range on /me/usage or /me/jobs. |
| 422 | Validation details (a list) | POST /cbc: the body has a field other than url, region and slim, or no url. |
| 429 | Rate, concurrency or quota message | Wait for in-flight jobs to finish or slow down. See Rate limits. |
Best practices
- Send jobs in parallel. The system is built for volume: 20–50 jobs at once per region finish sooner overall than one-by-one submission. Keep in-flight jobs under your concurrency limit.
- Poll every 3–5 seconds. Faster polling does not speed a job up.
- Choose a TTL that fits your use. A short TTL gives you a quick, uncharged
expiredwhen a job cannot finish in time; the 1-hour default favours completion. - Retry only when
retriableis true. Charged answers such asproduct_not_availableare final.