Taobao and Tmall Product Reviews API (V3)
API health status
Healthy Available Limited Mostly unavailable No data
Loading health status...
Retrieves Taobao and Tmall product reviews by item ID with page-based pagination and configurable sorting. Use it to analyze customer feedback.
Parameters
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
token | query | string | Yes | - | Access token for this API service. |
itemId | query | string | Yes | - | Unique product identifier on Taobao/Tmall (item ID). |
orderType | query | string | No | feedbackdate | Sort order for the result set. Available Values: - feedbackdate: Sort by feedback date- general: General sorting |
page | query | integer | No | 1 | Page number for pagination. |
Code Samples
bash
curl --max-time 120 -X GET 'https://api.justoneapi.com/api/taobao/get-item-comment/v3?token=YOUR_API_KEY&itemId=VALUE'text
I want to use the "Product Reviews (V3)" API from JustOneAPI.
Base URL: https://api.justoneapi.com.
API Path: /api/taobao/get-item-comment/v3?token=YOUR_API_KEY&itemId=VALUE
API Endpoint: BASE_URL + /api/taobao/get-item-comment/v3?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/taobao-and-tmall/product-reviews-v3-en.json
Parameters:
- token (query): Access token for this API service. (Required)
- itemId (query): Unique product identifier on Taobao/Tmall (item ID). (Required)
- orderType (query): Sort order for the result set.
Available Values:
- `feedbackdate`: Sort by feedback date
- `general`: General sorting
- page (query): Page number for pagination.
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.python
import requests
BASE_URL = "https://api.justoneapi.com" # Provided by OpenAPI servers
url = BASE_URL + "/api/taobao/get-item-comment/v3?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")js
const BASE_URL = "https://api.justoneapi.com"; // Provided by OpenAPI servers
const url = BASE_URL + "/api/taobao/get-item-comment/v3?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`);
}
}java
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/taobao/get-item-comment/v3?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");
}
}
}go
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/taobao/get-item-comment/v3?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
<?php
$BASE_URL = 'https://api.justoneapi.com'; // Provided by OpenAPI servers
$url = $BASE_URL . '/api/taobao/get-item-comment/v3?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).
Review information7 fields
data.comments[]
Taobao and Tmall product review results. A successful result can contain an empty review list.
| Field | Type | Description |
|---|---|---|
rateId | integer | Review ID returned as a JSON integer. Preserve its full precision when storing or comparing it. |
content | string | Product review text. |
date | string | Review date and time in the platform's returned text format. |
rate | string | Rating value reported as text. |
likeCount | integer | Number of likes reported for this review. |
dayAfterConfirm | integer | Day count after confirmation reported for the review. |
noQna | boolean | Whether the review is marked as having Q&A disabled. |
Review photos and sharing8 fields
data.comments[]
| Field | Type | Description |
|---|---|---|
photos | array | Photos attached to the original review. The list can be empty. |
photos[] | object | A photo attached to a review. |
photos[].url | string | Review photo URL. |
photos[].thumbnail | string | Thumbnail URL for the review photo. |
photos[].fileId | integer | File ID reported for the photo. |
shareInfo | object | Sharing metadata returned for the review. |
shareInfo.share | boolean | Share flag reported for the review. |
shareInfo.pic | integer | Original review photo count reported with the sharing metadata. |
Follow-up reviews21 fields
data.comments[]
| Field | Type | Description |
|---|---|---|
append | object | null | Follow-up review details when provided. This field can be null. |
append.appendId | integer | Follow-up review ID returned as a JSON integer. |
append.content | string | Follow-up review text. |
append.dayAfterConfirm | integer | Day count after confirmation reported for the follow-up review. |
append.photos | array | Photos attached to the follow-up review. The list can be empty. |
append.photos[] | object | A photo attached to a review. |
append.photos[].url | string | Review photo URL. |
append.photos[].thumbnail | string | Thumbnail URL for the review photo. |
append.photos[].fileId | integer | File ID reported for the photo. |
append.show | boolean | Whether the follow-up review is marked for display. |
appendList | array | Follow-up review entries returned with the review. The list can be empty. |
appendList[] | object | A follow-up review entry. |
appendList[].appendId | integer | Follow-up review ID returned as a JSON integer. |
appendList[].content | string | Follow-up review text. |
appendList[].dayAfterConfirm | integer | Day count after confirmation reported for the follow-up review. |
appendList[].photos | array | Photos attached to the follow-up review. The list can be empty. |
appendList[].photos[] | object | A photo attached to a review. |
appendList[].photos[].url | string | Review photo URL. |
appendList[].photos[].thumbnail | string | Thumbnail URL for the review photo. |
appendList[].photos[].fileId | integer | File ID reported for the photo. |
appendList[].show | boolean | Whether the follow-up review is marked for display. |
Reviewer6 fields
data.comments[].user
Reviewer profile fields returned with the review.
| Field | Type | Description |
|---|---|---|
nick | string | Reviewer display nickname as returned. |
avatar | string | Reviewer avatar URL. |
anony | boolean | Whether the review is marked anonymous. |
rank | integer | Account rank code reported for the reviewer. |
vipLevel | integer | Numeric VIP level reported for the reviewer. |
vip | string | VIP label reported for the reviewer. |
Product and specifications3 fields
data.comments[].auction
Product information attached to the review.
| Field | Type | Description |
|---|---|---|
aucNumId | string | Taobao or Tmall item ID returned as a string. |
link | string | Link for the reviewed product. It can be a protocol-relative URL. |
sku | string | Product specification text attached to this review. It can be empty. |
Pagination and counts9 fields
data
| Field | Type | Description |
|---|---|---|
comments | array | Reviews returned for the requested page and sort order. This list can be empty. |
total | integer | Review total reported for the product. |
totalFuzzy | string | Display text for the review total, which can be approximate. |
hasMediaCount | integer | Reported number of reviews with media. |
hasAppendCount | integer | Reported number of reviews with a follow-up. |
currentPageNum | integer | Current page number reported in the response. |
maxPage | integer | Maximum page number reported by the platform. Later pages can still contain reviews. |
hasNextPage | boolean | Whether the response marks a next page as available. A later page can contain reviews when the flag is false. |
qnaDisabled | boolean | Whether the result marks product Q&A as disabled. |
Review keywords6 fields
data
| Field | Type | Description |
|---|---|---|
keywords | array | Keyword labels returned for the reviews. The list can be empty. |
keywords[] | object | A keyword label for the review results. |
keywords[].word | string | Keyword text. |
keywords[].count | string | Displayed count for this keyword, returned as text. |
keywords[].labelId | string | Keyword label ID as returned. |
keywords[].type | string | Keyword type label as returned. |
Response Example
Loading the response example...