Query Product Detail Task Result
GET
/sp/v1/query/product_detailSubscriptions are managed on the product page. Subscribe to this product there before calling endpoints under it.
Overview
Query the result of a Shopee product detail task.
Use this endpoint to poll the asynchronous task status. When the task completes, the raw product detail payload is returned in data.source.
Request
GET /sp/v1/query/product_detail
Request Headers
| Name | Type | Required | Description |
|---|---|---|---|
| X-API-Token | string | yes | Permanent API token used for identity, billing, and rate limiting |
| X-API-Secret | string | yes | Rotatable API secret used to protect the credential from abuse |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| shop_id | string | yes | Shopee shop ID |
| item_id | string | yes | Shopee item ID |
| country | string | yes | Site code: id / tw / vn / th / ph / my / sg / br / mx |
| batch_id | string | no | Task batch ID; if returned during submit, pass it back unchanged |
Request Example
curl -G "https://api.bodapi.com/sp/v1/query/product_detail" \
-H "X-API-Token: YOUR_API_TOKEN" \
-H "X-API-Secret: YOUR_API_SECRET" \
--data-urlencode "shop_id=228694453" \
--data-urlencode "item_id=46957555694" \
--data-urlencode "country=tw" \
--data-urlencode "batch_id=2026-03-23"
Response Fields
Top-level fields
| Field | Type | Description |
|---|---|---|
| code | integer | Business status code: 0 success, -1 processing, -2 service exception |
| msg | string | Response message |
| data | object | Result object |
data fields
| Field | Type | Description |
|---|---|---|
| batch_id | string | Batch ID |
| source | object | null | Raw product detail payload; may be null before completion or on failure |
| crawled_at | string | null | Crawl completion time |
| error | string | null | Error message; usually null on success |
Response Example
{
"code": 0,
"msg": "success",
"data": {
"batch_id": "2026-03-23",
"crawled_at": "2026-03-23 10:16:57",
"error": null,
"source": {
"data": {
"item": {
"item_id": 46957555694,
"shop_id": 228694453,
"title": "Sample Taiwan listing",
"currency": "TWD",
"attributes": [
{
"name": "Material",
"value": "Other"
}
]
},
"shop_detailed": {
"shopid": 228694453,
"name": "佳儷塑形衣坊",
"rating_star": 4.759248
}
}
}
}
}
Status Semantics
code |
Meaning |
|---|---|
0 |
Task completed and data.source is ready |
-1 |
Task is still processing; poll again later |
-2 |
Service exception; inspect data.error and msg |
Notes
data.sourcemirrors the raw object shown in the OpenAPI example. It is large, nested, and should be treated as a flexible upstream payload.- Based on the example, the raw result commonly includes item data, attributes, reviews, and shop information.