Skip to content

Taobao and Tmall Product Search API (V1) ​

GET
API health status
Healthy Available Limited Mostly unavailable No data
Loading health status...

Searches Taobao and Tmall products by keyword with page, sort, optional Tmall-only, and inclusive price-range filters. Use it to discover products and narrow ecommerce research.

Parameters ​

NameInTypeRequiredDefaultDescription
tokenquerystringYes-Access token for this API service.
keywordquerystringYes-Search keyword.
sortquerystringNo_saleSort order for the result set.


Available Values:

- _sale: Sales

- _bid: Price: High to Low

- bid: Price: Low to High

- _coefp: General
tmallquerybooleanNofalseWhether to filter results to Tmall only.
startPricequerystringNo-Minimum price filter (inclusive).
endPricequerystringNo-Maximum price filter (inclusive).
pagequeryintegerNo1Page number for pagination.

Code Samples ​

bash
curl --max-time 120 -X GET 'https://api.justoneapi.com/api/taobao/search-item-list/v1?token=YOUR_API_KEY&keyword=VALUE'
text
I want to use the "Product Search (V1)" API from JustOneAPI.
Base URL: https://api.justoneapi.com.
API Path: /api/taobao/search-item-list/v1?token=YOUR_API_KEY&keyword=VALUE
API Endpoint: BASE_URL + /api/taobao/search-item-list/v1?token=YOUR_API_KEY&keyword=VALUE
HTTP Method: GET
Authentication: Append the "token" query parameter to the URL.
OpenAPI Definition: https://docs.justoneapi.com/openapi/taobao-and-tmall/product-search-v1-en.json

Parameters:
- token (query): Access token for this API service. (Required)
- keyword (query): Search keyword. (Required)
- sort (query): Sort order for the result set.

Available Values:
- `_sale`: Sales
- `_bid`: Price: High to Low
- `bid`: Price: Low to High
- `_coefp`: General
- tmall (query): Whether to filter results to Tmall only.
- startPrice (query): Minimum price filter (inclusive).
- endPrice (query): Maximum price filter (inclusive).
- 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/search-item-list/v1?token=YOUR_API_KEY&keyword=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/search-item-list/v1?token=YOUR_API_KEY&keyword=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/search-item-list/v1?token=YOUR_API_KEY&keyword=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/search-item-list/v1?token=YOUR_API_KEY&keyword=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/search-item-list/v1?token=YOUR_API_KEY&keyword=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).

Results and pagination15 fields

data

Taobao product search results for the requested page, with pagination metadata and search filters.

FieldTypeDescription
codestringSearch result status code returned inside the response data as text.
modelobjectSearch result object containing the current page, products, and filters.
model.successbooleanSuccess flag reported inside the search result object.
model.responseStatusintegerNumeric status code reported inside the search result object.
model.itemListarrayProduct listings returned for the current page. This list may be empty.
model.itemList[]objectOne product listing from the current search page.
model.pageobjectPagination numbers and result totals reported by the search.
model.page.pageNointegerCurrent page number reported by the search.
model.page.pageSizeintegerPage size reported by the search.
model.page.prevNointegerPrevious page number reported by the search.
model.page.nextNointegerNext page number reported by the search.
model.page.showBeginintegerStarting position in the reported display range.
model.page.showEndintegerEnding position in the reported display range.
model.page.totalItemsintegerTotal result count reported by the search. It can be positive when the current item list is empty.
model.page.totalPagesintegerTotal page count reported by the search.
Product details14 fields

data.model.itemList[]

FieldTypeDescription
itemIdintegerMarketplace listing ID, returned as an integer.
prodIdintegerProduct ID associated with the listing, when returned.
spuIdintegerStandard product unit (SPU) ID associated with the listing.
itemNamestringListing title shown in search results.
itemSubNamestringSupplementary listing title, which can be empty.
itemTypestringMarketplace listing type code, retained as text.
itemLocstringLocation shown for the listing.
frontStockintegerStock quantity reported in the search result.
hasTongkuanbooleanWhether matching listings for the same product are indicated.
hasXiangsibooleanWhether similar listings are indicated.
picUrlstringPrimary listing image URL as returned by the search.
picUrlFullstringFull URL for the primary listing image.
picUrlListarrayAdditional listing image URLs, when returned.
picUrlList[]stringURL for a listing image.
Prices and paid-order activity8 fields

data.model.itemList[]

FieldTypeDescription
priceFenintegerBase price in the integer representation supplied by the search result.
priceYuanDoublenumberBase price in the decimal representation supplied by the search result.
priceZKFenintegerDiscounted price in the integer representation supplied by the search result.
priceZKYuanDoublenumberDiscounted price in the decimal representation supplied by the search result.
discntPriceYuannumberPromotional price reported for the listing.
discntRateintegerDiscount rate value in the original scale used by the search result.
discntTypestringDiscount type code reported for the listing.
orderPayUVstringDisplayed count of buyers who paid, returned as text that may include a plus sign.
Shop and ratings8 fields

data.model.itemList[]

FieldTypeDescription
shopIdintegerShop ID associated with the listing, returned as an integer.
shopNamestringShop display name in the search result.
sellerLocstringLocation shown for the seller.
sellerLevelintegerSeller level code reported by the marketplace.
sellerGoodratintegerSeller positive feedback value in the scale reported by the marketplace.
miaoshuDsrstringSeller rating for accuracy of the item description, returned as text.
fuwuDsrstringSeller service rating, returned as text.
fahuoDsrstringSeller dispatch rating, returned as text.
Brand and attribute filters14 fields

data.model

FieldTypeDescription
brandListarrayBrands reported as search filters.
brandList[]objectA brand filter option.
brandList[].brandIdintegerBrand ID for the filter option.
brandList[].brandNamestringDisplay name of the brand filter option.
brandList[].countintegerResult count reported for this brand filter option.
propertyListarrayProduct attributes reported as search filters.
propertyList[]objectA filterable product attribute.
propertyList[].pidintegerID of the filterable product attribute.
propertyList[].pnamestringDisplay name of the filterable product attribute.
propertyList[].valueListarrayValues reported for the attribute filter.
propertyList[].valueList[]objectAn available filter value for this attribute.
propertyList[].valueList[].vidintegerID of the attribute filter value.
propertyList[].valueList[].vnamestringDisplay name of the attribute filter value.
propertyList[].valueList[].countintegerResult count reported for this attribute value.

Response Example ​

Loading the response example...