Submit Product Detail Task
GET
/sp/v1/submit/product_detailSubscriptions are managed on the product page. Subscribe to this product there before calling endpoints under it.
Overview
Submit a Shopee product detail crawl task.
This endpoint only creates an asynchronous task and does not return the product detail payload directly. After submission succeeds, use the returned batch_id to poll the query endpoint.
Request
GET /sp/v1/submit/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 | Batch ID, defaults to the current date |
| priority | integer | no | Task priority, default 0, range 0 to 100000 |
| deadline | string(date-time) | no | Task deadline, defaults to the next midnight |
Request Example
curl -G "https://api.bodapi.com/sp/v1/submit/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" \
--data-urlencode "priority=10" \
--data-urlencode "deadline=2026-03-24T00:00:00Z"
Response Fields
| Field | Type | Description |
|---|---|---|
| code | integer | Business status code, 0 means submission accepted |
| msg | string | Response message |
| data.batch_id | string | Task batch ID for subsequent polling |
Response Example
{
"code": 0,
"msg": "提交成功",
"data": {
"batch_id": "2026-03-23"
}
}
Notes
- When querying the result, keep using the same
shop_id,item_id,country, and preferably the returnedbatch_id. - The OpenAPI spec does not declare other HTTP status codes, so rely on
codeandmsgin the response body.