---
title: "Taobao and Tmall Product Search API (V1)"
description: "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."
aiUsagePrompt: true
---

# Taobao and Tmall Product Search API \(V1\)

<ApiTester
  method="GET"
  :path='JSON.parse("\"/api/taobao/search-item-list/v1\"")'
  :summary='JSON.parse("\"Product Search (V1)\"")'
  openapiDefinitionUrl="https://docs.justoneapi.com/openapi/taobao-and-tmall/product-search-v1-en.json"
  openapiVersion="3.1.0"
  :parameters='JSON.parse("[{\"name\":\"token\",\"in\":\"query\",\"description\":\"Access token for this API service.\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"keyword\",\"in\":\"query\",\"description\":\"Search keyword.\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"sort\",\"in\":\"query\",\"description\":\"Sort order for the result set.\\n\\nAvailable Values:\\n- `_sale`: Sales\\n- `_bid`: Price: High to Low\\n- `bid`: Price: Low to High\\n- `_coefp`: General\",\"required\":false,\"schema\":{\"type\":\"string\",\"default\":\"_sale\",\"description\":\"Taobao search item list sorting options\",\"enum\":[\"_sale\",\"_bid\",\"bid\",\"_coefp\"]}},{\"name\":\"tmall\",\"in\":\"query\",\"description\":\"Whether to filter results to Tmall only.\",\"required\":false,\"schema\":{\"type\":\"boolean\",\"default\":false}},{\"name\":\"startPrice\",\"in\":\"query\",\"description\":\"Minimum price filter (inclusive).\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"endPrice\",\"in\":\"query\",\"description\":\"Maximum price filter (inclusive).\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"page\",\"in\":\"query\",\"description\":\"Page number for pagination.\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":1}}]")'
  :requestBody='JSON.parse("null")'
  :responses='JSON.parse("{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"if\":{\"properties\":{\"code\":{\"const\":0}},\"required\":[\"code\"]},\"then\":{\"properties\":{\"data\":{\"type\":\"object\",\"description\":\"Taobao product search results for the requested page, with pagination metadata and search filters.\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Search result status code returned inside the response data as text.\"},\"model\":{\"type\":\"object\",\"description\":\"Search result object containing the current page, products, and filters.\",\"properties\":{\"success\":{\"type\":\"boolean\",\"description\":\"Success flag reported inside the search result object.\"},\"responseStatus\":{\"type\":\"integer\",\"description\":\"Numeric status code reported inside the search result object.\"},\"itemList\":{\"type\":\"array\",\"description\":\"Product listings returned for the current page. This list may be empty.\",\"items\":{\"type\":\"object\",\"description\":\"One product listing from the current search page.\",\"properties\":{\"itemId\":{\"type\":\"integer\",\"description\":\"Marketplace listing ID, returned as an integer.\"},\"prodId\":{\"type\":\"integer\",\"description\":\"Product ID associated with the listing, when returned.\"},\"spuId\":{\"type\":\"integer\",\"description\":\"Standard product unit (SPU) ID associated with the listing.\"},\"itemName\":{\"type\":\"string\",\"description\":\"Listing title shown in search results.\"},\"itemSubName\":{\"type\":\"string\",\"description\":\"Supplementary listing title, which can be empty.\"},\"itemType\":{\"type\":\"string\",\"description\":\"Marketplace listing type code, retained as text.\"},\"itemLoc\":{\"type\":\"string\",\"description\":\"Location shown for the listing.\"},\"frontStock\":{\"type\":\"integer\",\"description\":\"Stock quantity reported in the search result.\"},\"hasTongkuan\":{\"type\":\"boolean\",\"description\":\"Whether matching listings for the same product are indicated.\"},\"hasXiangsi\":{\"type\":\"boolean\",\"description\":\"Whether similar listings are indicated.\"},\"picUrl\":{\"type\":\"string\",\"description\":\"Primary listing image URL as returned by the search.\"},\"picUrlFull\":{\"type\":\"string\",\"description\":\"Full URL for the primary listing image.\"},\"picUrlList\":{\"type\":\"array\",\"description\":\"Additional listing image URLs, when returned.\",\"items\":{\"type\":\"string\",\"description\":\"URL for a listing image.\"}},\"priceFen\":{\"type\":\"integer\",\"description\":\"Base price in the integer representation supplied by the search result.\"},\"priceYuanDouble\":{\"type\":\"number\",\"description\":\"Base price in the decimal representation supplied by the search result.\"},\"priceZKFen\":{\"type\":\"integer\",\"description\":\"Discounted price in the integer representation supplied by the search result.\"},\"priceZKYuanDouble\":{\"type\":\"number\",\"description\":\"Discounted price in the decimal representation supplied by the search result.\"},\"discntPriceYuan\":{\"type\":\"number\",\"description\":\"Promotional price reported for the listing.\"},\"discntRate\":{\"type\":\"integer\",\"description\":\"Discount rate value in the original scale used by the search result.\"},\"discntType\":{\"type\":\"string\",\"description\":\"Discount type code reported for the listing.\"},\"orderPayUV\":{\"type\":\"string\",\"description\":\"Displayed count of buyers who paid, returned as text that may include a plus sign.\"},\"shopId\":{\"type\":\"integer\",\"description\":\"Shop ID associated with the listing, returned as an integer.\"},\"shopName\":{\"type\":\"string\",\"description\":\"Shop display name in the search result.\"},\"sellerLoc\":{\"type\":\"string\",\"description\":\"Location shown for the seller.\"},\"sellerLevel\":{\"type\":\"integer\",\"description\":\"Seller level code reported by the marketplace.\"},\"sellerGoodrat\":{\"type\":\"integer\",\"description\":\"Seller positive feedback value in the scale reported by the marketplace.\"},\"miaoshuDsr\":{\"type\":\"string\",\"description\":\"Seller rating for accuracy of the item description, returned as text.\"},\"fuwuDsr\":{\"type\":\"string\",\"description\":\"Seller service rating, returned as text.\"},\"fahuoDsr\":{\"type\":\"string\",\"description\":\"Seller dispatch rating, returned as text.\"}}}},\"page\":{\"type\":\"object\",\"description\":\"Pagination numbers and result totals reported by the search.\",\"properties\":{\"pageNo\":{\"type\":\"integer\",\"description\":\"Current page number reported by the search.\"},\"pageSize\":{\"type\":\"integer\",\"description\":\"Page size reported by the search.\"},\"prevNo\":{\"type\":\"integer\",\"description\":\"Previous page number reported by the search.\"},\"nextNo\":{\"type\":\"integer\",\"description\":\"Next page number reported by the search.\"},\"showBegin\":{\"type\":\"integer\",\"description\":\"Starting position in the reported display range.\"},\"showEnd\":{\"type\":\"integer\",\"description\":\"Ending position in the reported display range.\"},\"totalItems\":{\"type\":\"integer\",\"description\":\"Total result count reported by the search. It can be positive when the current item list is empty.\"},\"totalPages\":{\"type\":\"integer\",\"description\":\"Total page count reported by the search.\"}}},\"brandList\":{\"type\":\"array\",\"description\":\"Brands reported as search filters.\",\"items\":{\"type\":\"object\",\"description\":\"A brand filter option.\",\"properties\":{\"brandId\":{\"type\":\"integer\",\"description\":\"Brand ID for the filter option.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Display name of the brand filter option.\"},\"count\":{\"type\":\"integer\",\"description\":\"Result count reported for this brand filter option.\"}}}},\"propertyList\":{\"type\":\"array\",\"description\":\"Product attributes reported as search filters.\",\"items\":{\"type\":\"object\",\"description\":\"A filterable product attribute.\",\"properties\":{\"pid\":{\"type\":\"integer\",\"description\":\"ID of the filterable product attribute.\"},\"pname\":{\"type\":\"string\",\"description\":\"Display name of the filterable product attribute.\"},\"valueList\":{\"type\":\"array\",\"description\":\"Values reported for the attribute filter.\",\"items\":{\"type\":\"object\",\"description\":\"An available filter value for this attribute.\",\"properties\":{\"vid\":{\"type\":\"integer\",\"description\":\"ID of the attribute filter value.\"},\"vname\":{\"type\":\"string\",\"description\":\"Display name of the attribute filter value.\"},\"count\":{\"type\":\"integer\",\"description\":\"Result count reported for this attribute value.\"}}}}}}}}}}}}},\"allOf\":[{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\",\"enum\":[0,100,101,202,300,301,302,303,400,404,500,503,600,601,602]},\"message\":{\"type\":[\"string\",\"null\"]},\"data\":{},\"recordTime\":{\"type\":[\"string\",\"null\"]},\"requestId\":{\"type\":\"string\"},\"reason\":{\"type\":\"string\"},\"requestParams\":{\"type\":\"object\",\"properties\":{\"query\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\"}},\"body\":{\"type\":\"object\",\"properties\":{\"empty\":{\"type\":\"boolean\"},\"array\":{\"type\":\"boolean\"},\"null\":{\"type\":\"boolean\"},\"object\":{\"type\":\"boolean\"},\"float\":{\"type\":\"boolean\"},\"container\":{\"type\":\"boolean\"},\"valueNode\":{\"type\":\"boolean\"},\"integralNumber\":{\"type\":\"boolean\"},\"floatingPointNumber\":{\"type\":\"boolean\"},\"missingNode\":{\"type\":\"boolean\"},\"boolean\":{\"type\":\"boolean\"},\"binary\":{\"type\":\"boolean\"},\"nodeType\":{\"type\":\"string\",\"enum\":[\"ARRAY\",\"BINARY\",\"BOOLEAN\",\"MISSING\",\"NULL\",\"NUMBER\",\"OBJECT\",\"POJO\",\"STRING\"]},\"string\":{\"type\":\"boolean\"},\"pojo\":{\"type\":\"boolean\"},\"short\":{\"type\":\"boolean\"},\"int\":{\"type\":\"boolean\"},\"long\":{\"type\":\"boolean\"},\"double\":{\"type\":\"boolean\"},\"bigDecimal\":{\"type\":\"boolean\"},\"bigInteger\":{\"type\":\"boolean\"},\"textual\":{\"type\":\"boolean\",\"deprecated\":true},\"number\":{\"type\":\"boolean\"},\"embeddedValue\":{\"type\":\"boolean\"}}}}}},\"required\":[\"code\",\"data\",\"message\",\"recordTime\"]}]}}}},\"400\":{\"description\":\"Invalid request parameters or body\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\",\"enum\":[0,100,101,202,300,301,302,303,400,404,500,503,600,601,602]},\"message\":{\"type\":[\"string\",\"null\"]},\"data\":{},\"recordTime\":{\"type\":[\"string\",\"null\"]},\"requestId\":{\"type\":\"string\"},\"reason\":{\"type\":\"string\"},\"requestParams\":{\"type\":\"object\",\"properties\":{\"query\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\"}},\"body\":{\"type\":\"object\",\"properties\":{\"empty\":{\"type\":\"boolean\"},\"array\":{\"type\":\"boolean\"},\"null\":{\"type\":\"boolean\"},\"object\":{\"type\":\"boolean\"},\"float\":{\"type\":\"boolean\"},\"container\":{\"type\":\"boolean\"},\"valueNode\":{\"type\":\"boolean\"},\"integralNumber\":{\"type\":\"boolean\"},\"floatingPointNumber\":{\"type\":\"boolean\"},\"missingNode\":{\"type\":\"boolean\"},\"boolean\":{\"type\":\"boolean\"},\"binary\":{\"type\":\"boolean\"},\"nodeType\":{\"type\":\"string\",\"enum\":[\"ARRAY\",\"BINARY\",\"BOOLEAN\",\"MISSING\",\"NULL\",\"NUMBER\",\"OBJECT\",\"POJO\",\"STRING\"]},\"string\":{\"type\":\"boolean\"},\"pojo\":{\"type\":\"boolean\"},\"short\":{\"type\":\"boolean\"},\"int\":{\"type\":\"boolean\"},\"long\":{\"type\":\"boolean\"},\"double\":{\"type\":\"boolean\"},\"bigDecimal\":{\"type\":\"boolean\"},\"bigInteger\":{\"type\":\"boolean\"},\"textual\":{\"type\":\"boolean\",\"deprecated\":true},\"number\":{\"type\":\"boolean\"},\"embeddedValue\":{\"type\":\"boolean\"}}}}}},\"required\":[\"code\",\"data\",\"message\",\"recordTime\"]}}}},\"401\":{\"description\":\"Invalid or inactive access token\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\",\"enum\":[0,100,101,202,300,301,302,303,400,404,500,503,600,601,602]},\"message\":{\"type\":[\"string\",\"null\"]},\"data\":{},\"recordTime\":{\"type\":[\"string\",\"null\"]},\"requestId\":{\"type\":\"string\"},\"reason\":{\"type\":\"string\"},\"requestParams\":{\"type\":\"object\",\"properties\":{\"query\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\"}},\"body\":{\"type\":\"object\",\"properties\":{\"empty\":{\"type\":\"boolean\"},\"array\":{\"type\":\"boolean\"},\"null\":{\"type\":\"boolean\"},\"object\":{\"type\":\"boolean\"},\"float\":{\"type\":\"boolean\"},\"container\":{\"type\":\"boolean\"},\"valueNode\":{\"type\":\"boolean\"},\"integralNumber\":{\"type\":\"boolean\"},\"floatingPointNumber\":{\"type\":\"boolean\"},\"missingNode\":{\"type\":\"boolean\"},\"boolean\":{\"type\":\"boolean\"},\"binary\":{\"type\":\"boolean\"},\"nodeType\":{\"type\":\"string\",\"enum\":[\"ARRAY\",\"BINARY\",\"BOOLEAN\",\"MISSING\",\"NULL\",\"NUMBER\",\"OBJECT\",\"POJO\",\"STRING\"]},\"string\":{\"type\":\"boolean\"},\"pojo\":{\"type\":\"boolean\"},\"short\":{\"type\":\"boolean\"},\"int\":{\"type\":\"boolean\"},\"long\":{\"type\":\"boolean\"},\"double\":{\"type\":\"boolean\"},\"bigDecimal\":{\"type\":\"boolean\"},\"bigInteger\":{\"type\":\"boolean\"},\"textual\":{\"type\":\"boolean\",\"deprecated\":true},\"number\":{\"type\":\"boolean\"},\"embeddedValue\":{\"type\":\"boolean\"}}}}}},\"required\":[\"code\",\"data\",\"message\",\"recordTime\"]}}}},\"403\":{\"description\":\"Permission denied\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\",\"enum\":[0,100,101,202,300,301,302,303,400,404,500,503,600,601,602]},\"message\":{\"type\":[\"string\",\"null\"]},\"data\":{},\"recordTime\":{\"type\":[\"string\",\"null\"]},\"requestId\":{\"type\":\"string\"},\"reason\":{\"type\":\"string\"},\"requestParams\":{\"type\":\"object\",\"properties\":{\"query\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\"}},\"body\":{\"type\":\"object\",\"properties\":{\"empty\":{\"type\":\"boolean\"},\"array\":{\"type\":\"boolean\"},\"null\":{\"type\":\"boolean\"},\"object\":{\"type\":\"boolean\"},\"float\":{\"type\":\"boolean\"},\"container\":{\"type\":\"boolean\"},\"valueNode\":{\"type\":\"boolean\"},\"integralNumber\":{\"type\":\"boolean\"},\"floatingPointNumber\":{\"type\":\"boolean\"},\"missingNode\":{\"type\":\"boolean\"},\"boolean\":{\"type\":\"boolean\"},\"binary\":{\"type\":\"boolean\"},\"nodeType\":{\"type\":\"string\",\"enum\":[\"ARRAY\",\"BINARY\",\"BOOLEAN\",\"MISSING\",\"NULL\",\"NUMBER\",\"OBJECT\",\"POJO\",\"STRING\"]},\"string\":{\"type\":\"boolean\"},\"pojo\":{\"type\":\"boolean\"},\"short\":{\"type\":\"boolean\"},\"int\":{\"type\":\"boolean\"},\"long\":{\"type\":\"boolean\"},\"double\":{\"type\":\"boolean\"},\"bigDecimal\":{\"type\":\"boolean\"},\"bigInteger\":{\"type\":\"boolean\"},\"textual\":{\"type\":\"boolean\",\"deprecated\":true},\"number\":{\"type\":\"boolean\"},\"embeddedValue\":{\"type\":\"boolean\"}}}}}},\"required\":[\"code\",\"data\",\"message\",\"recordTime\"]}}}},\"429\":{\"description\":\"Request rate or daily quota limit exceeded\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\",\"enum\":[0,100,101,202,300,301,302,303,400,404,500,503,600,601,602]},\"message\":{\"type\":[\"string\",\"null\"]},\"data\":{},\"recordTime\":{\"type\":[\"string\",\"null\"]},\"requestId\":{\"type\":\"string\"},\"reason\":{\"type\":\"string\"},\"requestParams\":{\"type\":\"object\",\"properties\":{\"query\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\"}},\"body\":{\"type\":\"object\",\"properties\":{\"empty\":{\"type\":\"boolean\"},\"array\":{\"type\":\"boolean\"},\"null\":{\"type\":\"boolean\"},\"object\":{\"type\":\"boolean\"},\"float\":{\"type\":\"boolean\"},\"container\":{\"type\":\"boolean\"},\"valueNode\":{\"type\":\"boolean\"},\"integralNumber\":{\"type\":\"boolean\"},\"floatingPointNumber\":{\"type\":\"boolean\"},\"missingNode\":{\"type\":\"boolean\"},\"boolean\":{\"type\":\"boolean\"},\"binary\":{\"type\":\"boolean\"},\"nodeType\":{\"type\":\"string\",\"enum\":[\"ARRAY\",\"BINARY\",\"BOOLEAN\",\"MISSING\",\"NULL\",\"NUMBER\",\"OBJECT\",\"POJO\",\"STRING\"]},\"string\":{\"type\":\"boolean\"},\"pojo\":{\"type\":\"boolean\"},\"short\":{\"type\":\"boolean\"},\"int\":{\"type\":\"boolean\"},\"long\":{\"type\":\"boolean\"},\"double\":{\"type\":\"boolean\"},\"bigDecimal\":{\"type\":\"boolean\"},\"bigInteger\":{\"type\":\"boolean\"},\"textual\":{\"type\":\"boolean\",\"deprecated\":true},\"number\":{\"type\":\"boolean\"},\"embeddedValue\":{\"type\":\"boolean\"}}}}}},\"required\":[\"code\",\"data\",\"message\",\"recordTime\"]}}}},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\",\"enum\":[0,100,101,202,300,301,302,303,400,404,500,503,600,601,602]},\"message\":{\"type\":[\"string\",\"null\"]},\"data\":{},\"recordTime\":{\"type\":[\"string\",\"null\"]},\"requestId\":{\"type\":\"string\"},\"reason\":{\"type\":\"string\"},\"requestParams\":{\"type\":\"object\",\"properties\":{\"query\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\"}},\"body\":{\"type\":\"object\",\"properties\":{\"empty\":{\"type\":\"boolean\"},\"array\":{\"type\":\"boolean\"},\"null\":{\"type\":\"boolean\"},\"object\":{\"type\":\"boolean\"},\"float\":{\"type\":\"boolean\"},\"container\":{\"type\":\"boolean\"},\"valueNode\":{\"type\":\"boolean\"},\"integralNumber\":{\"type\":\"boolean\"},\"floatingPointNumber\":{\"type\":\"boolean\"},\"missingNode\":{\"type\":\"boolean\"},\"boolean\":{\"type\":\"boolean\"},\"binary\":{\"type\":\"boolean\"},\"nodeType\":{\"type\":\"string\",\"enum\":[\"ARRAY\",\"BINARY\",\"BOOLEAN\",\"MISSING\",\"NULL\",\"NUMBER\",\"OBJECT\",\"POJO\",\"STRING\"]},\"string\":{\"type\":\"boolean\"},\"pojo\":{\"type\":\"boolean\"},\"short\":{\"type\":\"boolean\"},\"int\":{\"type\":\"boolean\"},\"long\":{\"type\":\"boolean\"},\"double\":{\"type\":\"boolean\"},\"bigDecimal\":{\"type\":\"boolean\"},\"bigInteger\":{\"type\":\"boolean\"},\"textual\":{\"type\":\"boolean\",\"deprecated\":true},\"number\":{\"type\":\"boolean\"},\"embeddedValue\":{\"type\":\"boolean\"}}}}}},\"required\":[\"code\",\"data\",\"message\",\"recordTime\"]}}}},\"503\":{\"description\":\"Service temporarily unavailable\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\",\"enum\":[0,100,101,202,300,301,302,303,400,404,500,503,600,601,602]},\"message\":{\"type\":[\"string\",\"null\"]},\"data\":{},\"recordTime\":{\"type\":[\"string\",\"null\"]},\"requestId\":{\"type\":\"string\"},\"reason\":{\"type\":\"string\"},\"requestParams\":{\"type\":\"object\",\"properties\":{\"query\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\"}},\"body\":{\"type\":\"object\",\"properties\":{\"empty\":{\"type\":\"boolean\"},\"array\":{\"type\":\"boolean\"},\"null\":{\"type\":\"boolean\"},\"object\":{\"type\":\"boolean\"},\"float\":{\"type\":\"boolean\"},\"container\":{\"type\":\"boolean\"},\"valueNode\":{\"type\":\"boolean\"},\"integralNumber\":{\"type\":\"boolean\"},\"floatingPointNumber\":{\"type\":\"boolean\"},\"missingNode\":{\"type\":\"boolean\"},\"boolean\":{\"type\":\"boolean\"},\"binary\":{\"type\":\"boolean\"},\"nodeType\":{\"type\":\"string\",\"enum\":[\"ARRAY\",\"BINARY\",\"BOOLEAN\",\"MISSING\",\"NULL\",\"NUMBER\",\"OBJECT\",\"POJO\",\"STRING\"]},\"string\":{\"type\":\"boolean\"},\"pojo\":{\"type\":\"boolean\"},\"short\":{\"type\":\"boolean\"},\"int\":{\"type\":\"boolean\"},\"long\":{\"type\":\"boolean\"},\"double\":{\"type\":\"boolean\"},\"bigDecimal\":{\"type\":\"boolean\"},\"bigInteger\":{\"type\":\"boolean\"},\"textual\":{\"type\":\"boolean\",\"deprecated\":true},\"number\":{\"type\":\"boolean\"},\"embeddedValue\":{\"type\":\"boolean\"}}}}}},\"required\":[\"code\",\"data\",\"message\",\"recordTime\"]}}}}}")'
  :servers='JSON.parse("[{\"url\":\"https://api.justoneapi.com\",\"description\":\"Global production API (default)\"}]")'
  :security='JSON.parse("[]")'
  :securitySchemes='JSON.parse("{}")'
  :schemas='JSON.parse("{}")'
/>

<ApiHealthSection :api='JSON.parse("\"/api/taobao/search-item-list/v1\"")' />

<p>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.</p>

## Parameters

<div class="api-doc-table api-doc-table--params">

| Name | In | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| <code>token</code> | query | <code>string</code> | Yes | - | Access token for this API service. |
| <code>keyword</code> | query | <code>string</code> | Yes | - | Search keyword. |
| <code>sort</code> | query | <code>string</code> | No | <code>_sale</code> | Sort order for the result set.<br /><br><br>Available Values:<br /><br>- <code>_sale</code>: Sales<br /><br>- <code>_bid</code>: Price: High to Low<br /><br>- <code>bid</code>: Price: Low to High<br /><br>- <code>_coefp</code>: General |
| <code>tmall</code> | query | <code>boolean</code> | No | <code>false</code> | Whether to filter results to Tmall only. |
| <code>startPrice</code> | query | <code>string</code> | No | - | Minimum price filter (inclusive). |
| <code>endPrice</code> | query | <code>string</code> | No | - | Maximum price filter (inclusive). |
| <code>page</code> | query | <code>integer</code> | No | <code>1</code> | Page number for pagination. |

</div>

## Code Samples

::: code-group

```bash [🐚 cURL]
curl --max-time 120 -X GET 'https://api.justoneapi.com/api/taobao/search-item-list/v1?token=YOUR_API_KEY&keyword=VALUE'
```

```text [🤖 AI Prompt]
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 [🐍 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 [🌐 JavaScript]
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 [☕ 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 [🐹 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]
<?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;
}
```

:::

<div style="text-align: right; margin-top: -20px; margin-bottom: 20px;">
<a href="/openapi/taobao-and-tmall/product-search-v1-en.json" target="_blank" style="font-size: 12px; color: var(--vp-c-text-3); text-decoration: none; opacity: 0.8;">[OpenAPI Definition (JSON)]</a>
</div>

## Response Fields

Key fields in a successful response (`code = 0`).

<div class="api-doc-table api-doc-table--response">

| Field path | Type | Description |
| --- | --- | --- |
| <code>data</code> | <code>object</code> | Taobao product search results for the requested page, with pagination metadata and search filters. |
| <code>data.code</code> | <code>string</code> | Search result status code returned inside the response data as text. |
| <code>data.model</code> | <code>object</code> | Search result object containing the current page, products, and filters. |
| <code>data.model.success</code> | <code>boolean</code> | Success flag reported inside the search result object. |
| <code>data.model.responseStatus</code> | <code>integer</code> | Numeric status code reported inside the search result object. |
| <code>data.model.itemList</code> | <code>array</code> | Product listings returned for the current page. This list may be empty. |
| <code>data.model.itemList[]</code> | <code>object</code> | One product listing from the current search page. |
| <code>data.model.itemList[].itemId</code> | <code>integer</code> | Marketplace listing ID, returned as an integer. |
| <code>data.model.itemList[].prodId</code> | <code>integer</code> | Product ID associated with the listing, when returned. |
| <code>data.model.itemList[].spuId</code> | <code>integer</code> | Standard product unit (SPU) ID associated with the listing. |
| <code>data.model.itemList[].itemName</code> | <code>string</code> | Listing title shown in search results. |
| <code>data.model.itemList[].itemSubName</code> | <code>string</code> | Supplementary listing title, which can be empty. |
| <code>data.model.itemList[].itemType</code> | <code>string</code> | Marketplace listing type code, retained as text. |
| <code>data.model.itemList[].itemLoc</code> | <code>string</code> | Location shown for the listing. |
| <code>data.model.itemList[].frontStock</code> | <code>integer</code> | Stock quantity reported in the search result. |
| <code>data.model.itemList[].hasTongkuan</code> | <code>boolean</code> | Whether matching listings for the same product are indicated. |
| <code>data.model.itemList[].hasXiangsi</code> | <code>boolean</code> | Whether similar listings are indicated. |
| <code>data.model.itemList[].picUrl</code> | <code>string</code> | Primary listing image URL as returned by the search. |
| <code>data.model.itemList[].picUrlFull</code> | <code>string</code> | Full URL for the primary listing image. |
| <code>data.model.itemList[].picUrlList</code> | <code>array</code> | Additional listing image URLs, when returned. |
| <code>data.model.itemList[].picUrlList[]</code> | <code>string</code> | URL for a listing image. |
| <code>data.model.itemList[].priceFen</code> | <code>integer</code> | Base price in the integer representation supplied by the search result. |
| <code>data.model.itemList[].priceYuanDouble</code> | <code>number</code> | Base price in the decimal representation supplied by the search result. |
| <code>data.model.itemList[].priceZKFen</code> | <code>integer</code> | Discounted price in the integer representation supplied by the search result. |
| <code>data.model.itemList[].priceZKYuanDouble</code> | <code>number</code> | Discounted price in the decimal representation supplied by the search result. |
| <code>data.model.itemList[].discntPriceYuan</code> | <code>number</code> | Promotional price reported for the listing. |
| <code>data.model.itemList[].discntRate</code> | <code>integer</code> | Discount rate value in the original scale used by the search result. |
| <code>data.model.itemList[].discntType</code> | <code>string</code> | Discount type code reported for the listing. |
| <code>data.model.itemList[].orderPayUV</code> | <code>string</code> | Displayed count of buyers who paid, returned as text that may include a plus sign. |
| <code>data.model.itemList[].shopId</code> | <code>integer</code> | Shop ID associated with the listing, returned as an integer. |
| <code>data.model.itemList[].shopName</code> | <code>string</code> | Shop display name in the search result. |
| <code>data.model.itemList[].sellerLoc</code> | <code>string</code> | Location shown for the seller. |
| <code>data.model.itemList[].sellerLevel</code> | <code>integer</code> | Seller level code reported by the marketplace. |
| <code>data.model.itemList[].sellerGoodrat</code> | <code>integer</code> | Seller positive feedback value in the scale reported by the marketplace. |
| <code>data.model.itemList[].miaoshuDsr</code> | <code>string</code> | Seller rating for accuracy of the item description, returned as text. |
| <code>data.model.itemList[].fuwuDsr</code> | <code>string</code> | Seller service rating, returned as text. |
| <code>data.model.itemList[].fahuoDsr</code> | <code>string</code> | Seller dispatch rating, returned as text. |
| <code>data.model.page</code> | <code>object</code> | Pagination numbers and result totals reported by the search. |
| <code>data.model.page.pageNo</code> | <code>integer</code> | Current page number reported by the search. |
| <code>data.model.page.pageSize</code> | <code>integer</code> | Page size reported by the search. |
| <code>data.model.page.prevNo</code> | <code>integer</code> | Previous page number reported by the search. |
| <code>data.model.page.nextNo</code> | <code>integer</code> | Next page number reported by the search. |
| <code>data.model.page.showBegin</code> | <code>integer</code> | Starting position in the reported display range. |
| <code>data.model.page.showEnd</code> | <code>integer</code> | Ending position in the reported display range. |
| <code>data.model.page.totalItems</code> | <code>integer</code> | Total result count reported by the search. It can be positive when the current item list is empty. |
| <code>data.model.page.totalPages</code> | <code>integer</code> | Total page count reported by the search. |
| <code>data.model.brandList</code> | <code>array</code> | Brands reported as search filters. |
| <code>data.model.brandList[]</code> | <code>object</code> | A brand filter option. |
| <code>data.model.brandList[].brandId</code> | <code>integer</code> | Brand ID for the filter option. |
| <code>data.model.brandList[].brandName</code> | <code>string</code> | Display name of the brand filter option. |
| <code>data.model.brandList[].count</code> | <code>integer</code> | Result count reported for this brand filter option. |
| <code>data.model.propertyList</code> | <code>array</code> | Product attributes reported as search filters. |
| <code>data.model.propertyList[]</code> | <code>object</code> | A filterable product attribute. |
| <code>data.model.propertyList[].pid</code> | <code>integer</code> | ID of the filterable product attribute. |
| <code>data.model.propertyList[].pname</code> | <code>string</code> | Display name of the filterable product attribute. |
| <code>data.model.propertyList[].valueList</code> | <code>array</code> | Values reported for the attribute filter. |
| <code>data.model.propertyList[].valueList[]</code> | <code>object</code> | An available filter value for this attribute. |
| <code>data.model.propertyList[].valueList[].vid</code> | <code>integer</code> | ID of the attribute filter value. |
| <code>data.model.propertyList[].valueList[].vname</code> | <code>string</code> | Display name of the attribute filter value. |
| <code>data.model.propertyList[].valueList[].count</code> | <code>integer</code> | Result count reported for this attribute value. |

</div>

## Response Example

<ApiExampleSection :api='JSON.parse("\"/api/taobao/search-item-list/v1\"")' />

