bodapi
APIs/E-commerce Data
Sign Up to Subscribe

Shopee Product Detail Task API

Submit and query Shopee product detail raw data through an async task workflow.

Subscribe to This Product

Pricing plans belong to this product. Choose a plan for this product here.

Free免费积分包

Free

100 credits included

  • Billing model: Credit package
  • 100 积分
Sign Up to Subscribe

Overview

The Shopee Product Detail Task API uses an asynchronous workflow.

  • Step 1: submit a crawl task and receive a batch_id
  • Step 2: poll the query endpoint for task status
  • Step 3: read the raw product detail payload from data.source when code = 0

Basics

  • Base URL: https://api.bodapi.com
  • Auth headers: X-API-Token: YOUR_API_TOKEN and X-API-Secret: YOUR_API_SECRET
  • Method style: GET
  • Response format: application/json
  • Version: sp/v1

Workflow

  1. Submit task: GET /sp/v1/submit/product_detail
  2. Store the returned batch_id
  3. Query result: GET /sp/v1/query/product_detail
  4. code = 0 means completed, code = -1 means still processing, and code = -2 means service exception

Common Parameters

Name In Type Required Description
shop_id query string yes Shopee shop ID
item_id query string yes Shopee item ID
country query string yes Site code: id / tw / vn / th / ph / my / sg / br / mx
X-API-Token header string yes Permanent API token used for identity, billing, and rate limiting
X-API-Secret header string yes Rotatable API secret used to protect the credential from abuse

Common Response Shape

Field Type Description
code integer Business status code; 0 is success, negative values mean pending or failed
msg string Server message
data object Business payload

Notes

  • The OpenAPI spec only declares HTTP 200; use code to determine the real task state.
  • data.source in the query endpoint is the raw upstream product detail object. It is large and may evolve with upstream changes.
  • If batch_id is omitted on submit, the spec states that the current date is used by default.