1688 Product Search
Use the 1688 Product Search API for ecommerce API integration. Review request parameters, response fields, and runnable examples.
/v1 /alibaba /1688 /products /searchAPI data samples
Inspect the request body and complete response shape used by this endpoint.
{
"keyword": "瑜伽裤",
"sort": "sales_desc"
}{
"request_id": "5d2c1b0e-7c1f-4a52-9a54-0d6f3a1b8e21",
"data": {
"products": [
{
"product_id": "1062295546255",
"title": "冰丝安全裤女夏季薄款防走光可外穿不卷边保险短裤弹力居家打底裤",
"price": 9,
"currency": "CNY",
"sold_count": 100000,
"shop_name": null,
"repurchase_rate": null,
"image_url": "https://cbu01.alicdn.com/img/ibank/O1CN01PmAJAH1hurHecPD7L_!!2222582404338-0-cib.jpg",
"product_url": "https://detail.1688.com/offer/1062295546255.html"
},
{
"product_id": "1060133641492",
"title": "网红鲨鱼裤飞机裤夏季女士安全裤外穿防走光修身提臀瑜伽短裤打底",
"price": 10,
"currency": "CNY",
"sold_count": 100000,
"shop_name": null,
"repurchase_rate": null,
"image_url": "https://cbu01.alicdn.com/img/ibank/O1CN01AbYKkc1hurHUxdyda_!!2222582404338-0-cib.jpg",
"product_url": "https://detail.1688.com/offer/1060133641492.html"
}
],
"page": 1,
"total": 2000
}
}Availability: Available
This endpoint is active in the v1 gateway, OpenAPI, and subscription catalog. A successful call consumes 1 billing unit.
POST /v1/alibaba/1688/products/search
The request and response fields below match the current public contract.
MCP
| Item | Value |
|---|---|
| MCP Code | alibaba_1688_products_search |
Quick call
First create an API key, then store it in a server-side environment variable:
export ECOMMERCE_DATA_API_KEY="your_api_key"curl --request POST \
--url https://ecommercedataapi.com/v1/alibaba/1688/products/search \
--header "Content-Type: application/json" \
--header "X-API-Key: ${ECOMMERCE_DATA_API_KEY}" \
--data '{
"keyword": "瑜伽裤",
"sort": "sales_desc"
}'Integrate with an AI CLI
Copy for your AI CLI
Paste this task into Codex, Claude Code, Gemini CLI, or another coding agent.
Integrate the "1688 Product Search" endpoint from Ecommerce Data API into the current repository. Make the changes directly instead of only returning sample code.
API documentation: https://ecommercedataapi.com/en/docs/alibaba/1688/product-search
Endpoint: POST https://ecommercedataapi.com/v1/alibaba/1688/products/search
API key environment variable: ECOMMERCE_DATA_API_KEY
Example request:
{
"keyword": "瑜伽裤",
"sort": "sales_desc"
}
Requirements:
1. Read the API documentation first, then inspect the repository's language, framework, HTTP client, directory structure, and environment-variable conventions.
2. Reuse the existing API client and error-handling patterns. If none exist, add the smallest reusable Ecommerce Data API client and an endpoint-specific wrapper.
3. Read the key from the server-side ECOMMERCE_DATA_API_KEY environment variable and send Content-Type: application/json plus the X-API-Key header. Never write a real key into source code, browser code, logs, test snapshots, or Git.
4. If the environment variable is missing, tell me to configure ECOMMERCE_DATA_API_KEY myself. Do not request, print, or invent the real key, and continue implementing code and tests that do not require a live request.
5. Implement request and response types from the documentation. Handle non-2xx responses, request_id, error.code, error.message, and 429 rate limits.
6. Add a minimal usage example or test that follows the repository's conventions. Run one minimal live request only when the key is already configured and external requests are allowed; otherwise use mocks or static validation.
7. Run the relevant formatter, type checker, and tests. Report changed files, usage, verification results, and any environment variable I still need to configure.Open this request in Postman
Download the preconfigured collection for this endpoint, then import it into Postman.
Node.js example
const response = await fetch(
'https://ecommercedataapi.com/v1/alibaba/1688/products/search',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-Key': process.env.ECOMMERCE_DATA_API_KEY,
},
body: JSON.stringify({
keyword: '瑜伽裤',
sort: 'sales_desc',
}),
}
);
const result = await response.json();
if (!response.ok) {
throw new Error(`${result.error?.code}: ${result.error?.message}`);
}
console.log(result.data);Python example
import os
import requests
response = requests.post(
"https://ecommercedataapi.com/v1/alibaba/1688/products/search",
headers={
"Content-Type": "application/json",
"X-API-Key": os.environ["ECOMMERCE_DATA_API_KEY"],
},
json={
"keyword": "瑜伽裤",
"sort": "sales_desc",
},
timeout=30,
)
response.raise_for_status()
print(response.json()["data"])Request body
Send the fields below directly in the JSON body without an extra wrapper. Undefined fields are rejected.
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
keyword | String | Yes | Search keyword. Chinese keywords match far more listings than English ones. | 瑜伽裤 |
sort | String | No | Result order: default, sales_desc (best selling first), price_asc or price_desc. | sales_desc |
page | Integer | No | Page number, starting at 1. | 1 |
size | Integer | No | Results per page, 1–40. Default 20. | 20 |
Response structure
| Field | Type | Description |
|---|---|---|
request_id | String | Unique identifier for this request. |
data | Object | Endpoint business data. |
The fields below are inside data. For array endpoints they describe one array item; for paginated endpoints they describe one record in items[].
Response fields
| Field | Type | Description | Example |
|---|---|---|---|
products.product_id | String | 1688 listing ID; pass it to 1688 Product Details. | 929196455687 |
products.title | String | Listing title, in Chinese. | - |
products.price | Number | Supplier price in CNY. Listings with tiered or per-SKU prices show the lowest; call Product Details for the tiers. | 14.9 |
products.currency | String | Currency code, always CNY. | CNY |
products.sold_count | Integer | Units sold as shown on the listing. Search results cap this at 100000. | 14000 |
products.shop_name | String | Supplier shop name. Null in keyword search results. | 苏州满星源商贸有限公司 |
products.repurchase_rate | String | Share of buyers who ordered again, as a percentage string. Image search only; null elsewhere. | 47% |
products.image_url | String | Main image URL. | - |
products.product_url | String | Listing page URL on 1688. | - |
page | Integer | Page number returned. | 1 |
total | Integer | Number of matching listings the search can page through. | 2000 |
Response example
{
"request_id": "5d2c1b0e-7c1f-4a52-9a54-0d6f3a1b8e21",
"data": {
"products": [
{
"product_id": "1062295546255",
"title": "冰丝安全裤女夏季薄款防走光可外穿不卷边保险短裤弹力居家打底裤",
"price": 9,
"currency": "CNY",
"sold_count": 100000,
"shop_name": null,
"repurchase_rate": null,
"image_url": "https://cbu01.alicdn.com/img/ibank/O1CN01PmAJAH1hurHecPD7L_!!2222582404338-0-cib.jpg",
"product_url": "https://detail.1688.com/offer/1062295546255.html"
},
{
"product_id": "1060133641492",
"title": "网红鲨鱼裤飞机裤夏季女士安全裤外穿防走光修身提臀瑜伽短裤打底",
"price": 10,
"currency": "CNY",
"sold_count": 100000,
"shop_name": null,
"repurchase_rate": null,
"image_url": "https://cbu01.alicdn.com/img/ibank/O1CN01AbYKkc1hurHUxdyda_!!2222582404338-0-cib.jpg",
"product_url": "https://detail.1688.com/offer/1060133641492.html"
}
],
"page": 1,
"total": 2000
}
}See Errors and rate limits for error payloads, request tracing, and rate-limit headers.