# Taobao shop products API

> The products a Taobao or Tmall shop sells, 60 a page: title, price and list price, buyers in the last 30 days, review count and image, by sales, newest, seller credit or price. Takes the seller ID and the shop ID, both in a product's details.

Canonical page: https://okdata.online/apis/taobao/shops/products/list/

- **Endpoint**: `GET /v1/taobao/shops/products/list`
- **ID**: `taobao.shops.products.list`
- **Price**: $0.043 per call · about 60 products per page
- **Returns**: a page of about 60 products (`data.items`, Product objects)
- **Status**: preview
- **Good for**: Competitor monitoring, Product research

## Price

One call costs $0.043 and returns one page of about 60 products. Collecting 1,000 products takes about 17 calls, $0.731 in total. Each page is a separate call. A call that reached the data source is charged even when it comes back empty, not found or failed; calls stopped before reaching a source are free.

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `id` | string | yes |  | The seller ID (also called user ID): shop.id in a product's details or in search results. (e.g. `4219453987`) |
| `shop_id` | string | yes |  | The shop ID: ext.shop_id in a product's details, or the number in a shop<id>.taobao.com link. (e.g. `425752538`) |
| `sort` | string: sales / newest / credit / price_asc / price_desc | no | `sales` | Best sellers first (the default), newest, seller credit, or by price. |
| `cursor` | string | no |  | Opaque cursor from page.next_cursor of the previous call. Each page is a separate call. |
| `view` | string: compact / standard / full | no | `standard` | How much of each object comes back. full adds platform-specific fields under ext. |
| `fields` | string[] | no |  | Fields to keep, by path (author.name), to save tokens. In a query string: comma-separated. |

cursor, view and fields work as described in [Requests](https://okdata.online/docs/requests/).

## Returned fields

Each item is a [Product](https://okdata.online/docs/objects/product/).

| Field | Type | Description |
|---|---|---|
| `id` | string | Product ID in the shop. |
| `url` | string | Product page. |
| `title` | string | Product title. |
| `price` | number \| null | Current price (the lowest variant), in the currency given. |
| `original_price` | number \| null | List price before discount, where shown. |
| `currency` | string \| null | ISO 4217 currency code. |
| `sold` | integer \| null | Units sold, as the shop shows it. |
| `rating` | number \| null | Average stars, 0 to 5. |
| `reviews` | integer \| null | Number of reviews. |
| `images` | string[] \| null | Product image URLs. |
| `shop` | ShopRef | Who sells it. |
| `ext` | object | Platform-specific extras. Only returned with view=full. |

## Request examples

### cURL

```bash
curl -G "https://api.okdata.online/v1/taobao/shops/products/list" \
  -H "Authorization: Bearer $OKDATA_API_KEY" \
  --data-urlencode 'id=4219453987' \
  --data-urlencode 'shop_id=425752538'
```

### Python

```python
import os
import requests

resp = requests.get(
    "https://api.okdata.online/v1/taobao/shops/products/list",
    headers={"Authorization": f"Bearer {os.environ['OKDATA_API_KEY']}"},
    params={"id": "4219453987", "shop_id": "425752538"},
    timeout=60,
)
body = resp.json()
if body["code"] != "ok":
    raise RuntimeError(f"{body['code']}: {body['message']} (charged: {body['charged']})")

for row in body["data"]["items"]:
    print(row["price"], row["currency"], row["sold"], row["title"][:60])
print("cost: $" + body["meta"]["billing"]["amount"])
```

### TypeScript

```ts
const url = new URL('https://api.okdata.online/v1/taobao/shops/products/list');
url.searchParams.set('id', "4219453987");
url.searchParams.set('shop_id', "425752538");

const res = await fetch(url, {
  headers: {
    Authorization: `Bearer ${process.env.OKDATA_API_KEY}`,
  },
});
const body = await res.json();
if (body.code !== 'ok') throw new Error(`${body.code}: ${body.message}`);

for (const row of body.data.items) {
  console.log(row.price, row.currency, row.sold, row.title.slice(0, 60));
}
console.log('cost: $' + body.meta.billing.amount);
```

### MCP

```json
{
  "name": "call",
  "arguments": {
    "capability": "taobao.shops.products.list",
    "id": "4219453987",
    "shop_id": "425752538"
  }
}
```

Or ask an agent that has the MCP server connected:

> Use Taobao shop products and show the price range and the five best sellers, with links.

## Response example

```json
{
  "code": "ok",
  "request_id": "0f6c2a8e-4b1d-4e0a-9a51-3c7d2b9e1f20",
  "data": {
    "items": [
      {
        "id": "708174321498",
        "url": "https://detail.tmall.com/item.htm?id=708174321498",
        "title": "Cliton电动磨豆机家用便携式手冲咖啡研磨机",
        "price": 80,
        "original_price": 218,
        "currency": "CNY",
        "sold": 1000,
        "rating": null,
        "reviews": null,
        "images": [
          "https://cdn.example.com/product/1.jpg"
        ],
        "shop": {
          "id": "4219453987",
          "name": "cliton旗舰店",
          "url": "https://shop425752538.taobao.com"
        }
      }
    ]
  },
  "page": {
    "next_cursor": "eyJvIjoyMH0",
    "has_more": true
  },
  "warnings": [],
  "meta": {
    "capability": "taobao.shops.products.list",
    "billing": {
      "amount": "0.043",
      "currency": "USD",
      "balance_after": "9.957"
    },
    "unavailable": {},
    "cached": false,
    "replayed": false,
    "fetched_at": "2026-11-11T08:00:00Z"
  }
}
```

## Errors

Errors share one shape: code, request_id, message and message_zh (a fixed sentence per code), charged, retry, retry_after_seconds, param and docs_url, with the specifics in problems. An error from a call that reached the data source (not found, a failure or a timeout of the source) is charged once at this endpoint's price, with charged: true and amount; errors before that, such as bad parameters, are not charged. Only settlement_unknown is unknown until looked up. The full table: https://okdata.online/docs/errors/

## Questions

### How much does the Taobao shop products API cost?

One call costs $0.043 and returns one page of about 60 products. Collecting 1,000 products takes about 17 calls, $0.731 in total. Each page is a separate call. A call that reached the data source is charged even when it comes back empty, not found or failed; calls stopped before reaching a source are free.

### How do I get the next page?

Pass page.next_cursor from the response back as the cursor parameter. When page.has_more is false there is nothing left. Every page is its own call at $0.043.

### Do I need a Taobao & Tmall account, cookies or a QR login?

No. You send only your okdata API key. The data is public data from Taobao & Tmall; nothing is fetched with your own Taobao & Tmall account.

### Am I charged when a call fails?

Yes, once, when the call reached the data source: an empty answer, a not_found, a failure or a timeout of the source costs one call (one item for per-item endpoints), and the error says charged: true with amount. Calls refused before reaching a source, such as bad parameters or a low balance, cost nothing.

### What if Taobao & Tmall does not show a field?

The field is null, and meta.unavailable names it with the reason: platform (the platform never shows it) or capability (we cannot fetch it yet).

## More Taobao & Tmall endpoints

- [Taobao product search](https://okdata.online/apis/taobao/products/search/): $0.043 per call · about 10 products per page
- [Taobao product details](https://okdata.online/apis/taobao/products/get/): $0.033 per call
- [Taobao product reviews](https://okdata.online/apis/taobao/products/reviews/list/): $0.043 per call · about 20 reviews per page

## At a glance

- **Short name**: Taobao shop products
- **Also called**: taobao shop items api
- **Category**: [E-commerce](https://okdata.online/categories/commerce/)
- **Status**: preview. It may still change; any change is announced beforehand.
- **Price**: $0.043 per call · bad parameters are free
- **Returns**: About 60 products a page, with a cursor for the next page
- **If a call fails**: Charged once. When a data source fails, the next one is tried. A call that reached a source is charged once even if it fails; bad parameters are free.

## When it is charged

- Data comes back: $0.043 per call
- Bad parameters, too little balance, a paused endpoint: Free

| When | Charge |
|---|---|
| Each further page | A new call: $0.043 |
| Most one call costs | $0.043 |
| An empty answer | $0.043 |
| Not found (the platform has no such item) | $0.043 |
| The data source fails or times out | $0.043 |
| Bad parameters, too little balance, a paused endpoint | Free |
| Resent with the same Idempotency-Key within 24 hours | Free when the kept result comes back |

A call that reached the data source costs $0.043 even when the answer is empty, not found or a failure of the source; a call stopped before that, such as for bad parameters, is free.

Prices from price book 84f29877acc83a88. [Every price on this platform](https://okdata.online/pricing/taobao/)

- New accounts get $0.10 of credit, no card needed: 2 calls to this endpoint.
- About 17 calls fetch 1,000 products: $0.731 in all.

## Known limits

- About 60 products come back per page; the platform sets the page size, so there is no page-size parameter.
- For the next page, pass `page.next_cursor` back as `cursor`. A cursor stays valid for 24 hours. When `page.has_more` is false there is nothing left.

## Fields by view

The view column is the smallest `view` a field comes back in: `compact` returns only compact fields, `standard` adds the standard ones, `full` returns everything. The default is `standard`.

- `compact`: `id`, `url`, `title`, `price`, `currency`, `sold`, `rating`, `reviews`, `shop`
- `standard`: `original_price`, `images`
- `full`: `ext`

## Common errors on this endpoint

| HTTP | Code | Meaning | Charged | Retry |
|---|---|---|---|---|
| 400 | `invalid_params` | A parameter is missing, has the wrong type or value, or the method is wrong. problems lists each one; param names the first. | no | after a fix |
| 400 | `cursor_mismatch` | The cursor was sent to another endpoint, or with other parameters than the page it came from (view and fields may change). | no | after a fix |
| 401 | `unauthorized` | The key is missing, malformed, revoked, disabled or expired (reason says which when known). | no | no |
| 402 | `insufficient_balance` | The balance (available) cannot cover the most this call could cost (required). | no | after a fix |
| 404 | `not_found` | The post, account or page does not exist or is not public. When the data source billed the lookup, or the endpoint's charge_when_not_found is above 0, this answer is charged: the body then says charged: true and amount. | once, if it reached a data source | no |
| 410 | `cursor_expired` | The cursor is older than the endpoint's cursor lifetime (page.cursor_expires_at said when). | no | no |
| 429 | `rate_limited` | The account sent too many requests this minute (reason: rate) or has too many calls running (reason: concurrency). | no | yes |
| 500 | `settlement_unknown` | The data came back, but the charge could not be confirmed. | unknown until looked up | with the same Idempotency-Key |
| 502 | `upstream_failed` | Every data source for this endpoint failed on this request. If a source billed the attempt, it is charged once at the endpoint's price (charged: true and amount); otherwise nothing is charged. | once, if it reached a data source | yes |
| 503 | `capability_paused` | This endpoint is paused right now; nothing ran. | no | yes |
| 504 | `timeout` | The data did not come back in time. If the request had reached a data source that bills it, it is charged once at the endpoint's price (charged: true and amount); otherwise the hold is released. | once, if it reached a data source | yes |

[All error codes](https://okdata.online/docs/errors/)

## Use it in your AI

> Read https://okdata.online/apis/taobao/shops/products/list.md, then call this endpoint for me through okdata; my key is in the OKDATA_API_KEY environment variable. Use Taobao shop products and show the price range and the five best sellers, with links.
