POST
https://api.nexscope.ai/tiktok/shop/product/detailRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/tiktok/shop/product/detail |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
productInput | string | required | TikTok HTTPS product URL (host must be `tiktok.com` or its subdomain, port must be omitted or `443`, path must contain consecutive `product/<19-digit ID>`), or 19-digit product ID. Product ID must be passed as a string to avoid loss of numeric precision. |
region | string | optional | Uppercase site codes: `US`, `GB`, `ID`, `MY`, `TH`, `VN`. `PH`, `SG`, `DE`, `FR`, `IT`, `ES`. Example: US |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
No response example is published for this API. Refer to the response fields below.
Response fields
Response field reference (20 fields)
| Name | Type | Required | Description |
|---|---|---|---|
errcode | integer | optional | Business status code; `200` indicates success. |
errmsg | string | optional | Business status message; `ok` on success. |
data | array | optional | Arranged product array; 1 item is fixed when successful. |
total | integer | optional | Fixed to `1` on success. |
costToken | integer | optional | Consume token. |
type | string | optional | Fixed to `tableListWorkbenches`. |
columns | array | optional | Rendering column definitions generated based on the product's top-level fields. |
productId | string | optional | Product ID. |
status | integer | optional | Platform product status code; cannot be used alone to determine saleability. |
title | string | optional | Product title |
category | object | optional | Category name and ID. |
pricing | object | optional | Currency, selling price, original price, discount and price original fields. |
sales | object | optional | Expose the sold quantity and sales display fields. |
inventory | object | optional | Total inventory, SKUs, sales attributes, SKU prices and default selections. |
media | object | optional | Image URL and image metadata. |
seller | object | optional | Store ID, name, rating, region, and available store fields. |
reviews | object | optional | Public comment profile, may be empty. |
shipping | object | optional | Logistics and distribution module, may be empty. |
actions | object | optional | Add-on, purchase and collection status. |
additional | object | optional | Promotions, user benefits, and other human-readable product modules can be large. |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.