Douyin E-commerce Item Details API (V2)
Retrieves Douyin E-commerce product details by item ID. Use it to inspect a known marketplace item for catalog or product research.
Highlights
Capability
This endpoint includes product sales data.
Parameters
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
token | query | string | Yes | - | Access token for this API service. |
itemId | query | string | Yes | - | The unique ID of the item on Douyin E-commerce. |
Code Samples
curl --max-time 120 -X GET 'https://api.justoneapi.com/api/douyin-ec/get-item-detail/v2?token=YOUR_API_KEY&itemId=VALUE'I want to use the "Item Details (V2)" API from JustOneAPI.
Base URL: https://api.justoneapi.com.
API Path: /api/douyin-ec/get-item-detail/v2?token=YOUR_API_KEY&itemId=VALUE
API Endpoint: BASE_URL + /api/douyin-ec/get-item-detail/v2?token=YOUR_API_KEY&itemId=VALUE
HTTP Method: GET
Authentication: Append the "token" query parameter to the URL.
OpenAPI Definition: https://docs.justoneapi.com/openapi/douyin-e-commerce/item-details-v2-en.json
Parameters:
- token (query): Access token for this API service. (Required)
- itemId (query): The unique ID of the item on Douyin E-commerce. (Required)
Return format: safely handle JSON or text according to the actual Content-Type.
Response Handling & Error Codes:
1. Business results should be determined by the "code" field in the response body (code 0 means success).
2. Timeout Recommendation: Set the request timeout to 120 seconds. If 120 seconds is too long for your use case, use at least 60 seconds, but a small number of requests may time out before receiving a result.
3. Business Code Reference:
- 0: Success
- 100: Invalid or Inactive Token
- 301: Collection Failed. Please Retry.
- 302: Rate Limit Exceeded
- 303: Daily Quota Exceeded
- 400: Invalid Parameters
- 500: Internal Server Error
- 600: Permission Denied
- 601: Insufficient Balance
- 602: Token Budget Exceeded
4. Code 601 means the shared account balance is insufficient. Code 602 means the current API token's own cumulative budget limit has been reached. Token budget limits do not transfer funds out of the shared account balance.
Please help me write a script in my preferred programming language to call this API and handle the response.import requests
BASE_URL = "https://api.justoneapi.com" # Provided by OpenAPI servers
url = BASE_URL + "/api/douyin-ec/get-item-detail/v2?token=YOUR_API_KEY&itemId=VALUE"
response = requests.get(url, timeout=120)
print(response.status_code)
if response.content:
content_type = response.headers.get("content-type", "").lower()
if "json" in content_type:
try:
print(response.json())
except ValueError:
print(response.text)
elif content_type.startswith("text/") or "xml" in content_type or content_type.split(";", 1)[0].strip() in {"application/javascript", "application/x-www-form-urlencoded", "application/graphql"}:
print(response.text)
else:
with open("response.bin", "wb") as output:
output.write(response.content)
print(f"Saved {len(response.content)} bytes to response.bin")const BASE_URL = "https://api.justoneapi.com"; // Provided by OpenAPI servers
const url = BASE_URL + "/api/douyin-ec/get-item-detail/v2?token=YOUR_API_KEY&itemId=VALUE";
const response = await fetch(url, {
method: "GET",
signal: AbortSignal.timeout(120000)
});
console.log(response.status);
const responseBytes = await response.arrayBuffer();
if (responseBytes.byteLength) {
const contentType = (response.headers.get("content-type") || "").toLowerCase();
const mediaType = contentType.split(";", 1)[0].trim();
const textual = contentType.startsWith("text/") || contentType.includes("json") || contentType.includes("xml") || ["application/javascript", "application/x-www-form-urlencoded", "application/graphql"].includes(mediaType);
if (textual) {
const responseText = new TextDecoder().decode(responseBytes);
let data = responseText;
if (contentType.includes("json")) {
try { data = JSON.parse(responseText); } catch { /* Keep the raw body. */ }
}
console.log(data);
} else {
console.log(`Received ${responseBytes.byteLength} binary bytes`);
}
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
public class Main {
public static void main(String[] args) throws Exception {
final String BASE_URL = "https://api.justoneapi.com"; // Provided by OpenAPI servers
final String url = BASE_URL + "/api/douyin-ec/get-item-detail/v2?token=YOUR_API_KEY&itemId=VALUE";
HttpClient client = HttpClient.newBuilder().connectTimeout(Duration.ofSeconds(120)).build();
HttpRequest.Builder builder = HttpRequest.newBuilder()
.uri(URI.create(url))
.timeout(Duration.ofSeconds(120))
.method("GET", HttpRequest.BodyPublishers.noBody());
HttpRequest request = builder.build();
HttpResponse<byte[]> response = client.send(request, HttpResponse.BodyHandlers.ofByteArray());
System.out.println(response.statusCode());
String contentType = response.headers().firstValue("content-type").orElse("").toLowerCase();
String mediaType = contentType.split(";", 2)[0].trim();
if (contentType.startsWith("text/") || contentType.contains("json") || contentType.contains("xml") || mediaType.equals("application/javascript") || mediaType.equals("application/x-www-form-urlencoded") || mediaType.equals("application/graphql")) {
System.out.println(new String(response.body(), StandardCharsets.UTF_8));
} else {
Files.write(Path.of("response.bin"), response.body());
System.out.println("Saved " + response.body().length + " bytes to response.bin");
}
}
}package main
import (
"fmt"
"io"
"os"
"strings"
"net/http"
"time"
)
const BASE_URL = "https://api.justoneapi.com" // Provided by OpenAPI servers
func main() {
client := &http.Client{Timeout: 120 * time.Second}
url := BASE_URL + "/api/douyin-ec/get-item-detail/v2?token=YOUR_API_KEY&itemId=VALUE"
req, _ := http.NewRequest("GET", url, nil)
resp, _ := client.Do(req)
defer resp.Body.Close()
fmt.Println(resp.StatusCode)
bodyBytes, _ := io.ReadAll(resp.Body)
contentType := strings.ToLower(resp.Header.Get("Content-Type"))
mediaType := strings.TrimSpace(strings.SplitN(contentType, ";", 2)[0])
if strings.HasPrefix(contentType, "text/") || strings.Contains(contentType, "json") || strings.Contains(contentType, "xml") || mediaType == "application/javascript" || mediaType == "application/x-www-form-urlencoded" || mediaType == "application/graphql" {
fmt.Println(string(bodyBytes))
} else {
os.WriteFile("response.bin", bodyBytes, 0600)
fmt.Printf("Saved %d bytes to response.bin\n", len(bodyBytes))
}
}<?php
$BASE_URL = 'https://api.justoneapi.com'; // Provided by OpenAPI servers
$url = $BASE_URL . '/api/douyin-ec/get-item-detail/v2?token=YOUR_API_KEY&itemId=VALUE';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_TIMEOUT, 120);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
$contentType = strtolower((string) curl_getinfo($ch, CURLINFO_CONTENT_TYPE));
curl_close($ch);
echo $status . PHP_EOL;
$mediaType = trim(explode(';', $contentType, 2)[0]);
if (str_starts_with($contentType, 'text/') || str_contains($contentType, 'json') || str_contains($contentType, 'xml') || in_array($mediaType, ['application/javascript', 'application/x-www-form-urlencoded', 'application/graphql'], true)) {
echo $response;
} else {
file_put_contents('response.bin', $response);
echo 'Saved ' . strlen($response) . ' bytes to response.bin' . PHP_EOL;
}Response Fields
Key fields in a successful response (code = 0).
Item identifiers3 fields
data
Douyin E-commerce item details with any available shop information and service labels.
| Field | Type | Description |
|---|---|---|
product_id | string | Identifier of the underlying Douyin E-commerce product. |
promotion_id | string | Promotion identifier returned for this lookup. It can match the supplied itemId. |
item_type | integer | Item type code reported for the product. |
Product information10 fields
data.model.product
Structured information about the product.
| Field | Type | Description |
|---|---|---|
product_base | object | Basic product information and images. |
product_base.title | string | Product title. |
product_base.cover | string | Product cover image URL. |
product_base.images | array | Product image URLs. |
product_base.images[] | string | URL of a product image. |
product_base.white_background | string | Product image URL for the white-background version. |
product_base.big_imgs | array | Image URLs from the product's large-image list. |
product_base.big_imgs[] | string | URL of an image in the large-image list. |
product_base.is_global_shoping | boolean | Indicates whether the product is marked as part of Douyin Global Shopping. |
product_base.is_sui_xin_tui | boolean | Indicates whether the product is marked for the Sui Xin Tui (随心推) promotion feature. |
Sales and reviews10 fields
data.model.product
| Field | Type | Description |
|---|---|---|
product_sales | object | Sales counts and a display label for the product. |
product_sales.product_label | object | Product sales label with a numeric count and a display string. |
product_sales.product_label.sales_num | integer | Numeric sales count in the product label. |
product_sales.product_label.sales_text | string | Sales count display text in the product label. |
product_sales.sell_num | integer | Sales count returned for the product. |
product_sales.total_sales | integer | Total sales count reported for the product. |
product_comment | object | Positive review percentage for the product, with its display label. |
product_comment.good_ratio | number | Positive review percentage as a number. A value of 83.6 means 83.6%. The display label may round this value. |
product_comment.comment_label | object | Display label for the product review metric. |
product_comment.comment_label.good_ratio | string | Formatted positive review percentage for display. |
Product benefits11 fields
data.model.product.product_privilege
Benefits and service promises displayed for the product.
| Field | Type | Description |
|---|---|---|
privilege_info_label | object | Display information for the product benefits. |
privilege_info_label.privilege_id | integer | Reported identifier of the product benefits group. |
privilege_info_label.privilege_info_detail | array | Benefit entries displayed for the product. |
privilege_info_label.privilege_info_detail[] | object | One product benefit entry. |
privilege_info_label.privilege_info_detail[].tag_id | string | Tag identifier for this benefit. |
privilege_info_label.privilege_info_detail[].title | string | Display title for this benefit. |
privilege_info_label.privilege_info_detail[].content | string | Display text describing this benefit. |
privilege_info_label.privilege_info_detail[].icon | object | Icon for the displayed benefit. |
privilege_info_label.privilege_info_detail[].icon.url_list | array | Image URLs for the benefit icon. |
privilege_info_label.privilege_info_detail[].icon.url_list[] | string | One image URL for this benefit icon. |
privilege_info_label.privilege_info_detail[].link | string | Douyin app link associated with the benefit, when provided. |
Shop information5 fields
data.model.shop
Information about the shop associated with the product.
| Field | Type | Description |
|---|---|---|
shop_id | string | Douyin E-commerce shop ID. |
shop_base | object | Basic shop information. |
shop_base.shop_name | string | Shop display name. |
shop_base.shop_logo | string | Shop logo image URL. |
shop_base.platform_source | integer | Platform source code reported for the shop. |
Auxiliary module status14 fields
data.model
Product, shop and auxiliary module information.
| Field | Type | Description |
|---|---|---|
promotion_data | object | Promotion module status. |
promotion_data.code | integer | Status code reported for this module. |
comment_data | object | Comment module status. |
comment_data.code | integer | Status code reported for this module. |
author_data | object | Author module status. |
author_data.code | integer | Status code reported for this module. |
content_data | object | Content module status. |
content_data.code | integer | Status code reported for this module. |
hot_content_data | object | Popular content module status. |
hot_content_data.code | integer | Status code reported for this module. |
shop_product_data | object | Shop products module status. |
shop_product_data.code | integer | Status code reported for this module. |
material_data | object | Materials module status. |
material_data.code | integer | Status code reported for this module. |
Service labels2 fields
data.label
Display labels associated with the product.
| Field | Type | Description |
|---|---|---|
service_module | object | Service modules displayed for the product. |
service_module.module_list | array | List of service modules. |
Service module headings9 fields
data.label.service_module.module_list[]
One displayed service module.
| Field | Type | Description |
|---|---|---|
module_type | string | Type identifier for the service module. |
title | object | Display heading for the service module. |
title.title_list | array | Display segments that make up the module heading. |
title.title_list[] | object | One display segment in the module heading. |
title.title_list[].rich_text | object | Rich-text information for the heading segment. |
title.title_list[].rich_text.rich_text_type | integer | Type code for the rich-text segment. |
title.title_list[].rich_text.text | object | Text object in the rich-text segment. |
title.title_list[].rich_text.text.text | string | Display text for the heading segment. |
title.title_list[].suffix_type | integer | Suffix type code for this display entry. |
Service module details13 fields
data.label.service_module.module_list[].content
Details shown in the service module.
| Field | Type | Description |
|---|---|---|
content_list | array | Display entries in the service module details. |
content_list[] | object | One entry in the service module details. |
content_list[].content_type | string | Type identifier for the display entry. |
content_list[].content | object | Display content for this entry. |
content_list[].content.title_list | array | Title segments for the display content. |
content_list[].content.title_list[] | object | One display title segment. |
content_list[].content.title_list[].rich_text | object | Rich-text information for the content title segment. |
content_list[].content.title_list[].rich_text.rich_text_type | integer | Type code for the rich-text segment. |
content_list[].content.title_list[].rich_text.text | object | Text object in the rich-text segment. |
content_list[].content.title_list[].rich_text.text.text | string | Display text for the content title segment. |
content_list[].content.title_list[].rich_text.text.font_color | string | Color value for the text. This field can be an empty string. |
content_list[].content.title_list[].suffix_type | integer | Suffix type code for this display entry. |
content_list[].suffix_type | integer | Suffix type code for this display entry. |