Skip to content
Scrappa Get API key
Tmall API 1 credit / request

Tmall Search API Documentation

GET https://scrappa.co/api/tmall/search

Search the public logged-out Tmall catalogue. Tmall rows are split from the shop-name badge in the same response and marked with is_tmall. Each result carries the item id string for the item endpoint, a CNY price with original price, shop, location, full-size images and tags. The public page serves one result page only. Page values above 1 are rejected. Failed requests are never charged.

Tmall Search API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/tmall/search
Auth header
x-api-key
Cost
1 credit / request
query = coffee shops
Response preview
200 OK
{
    "data": {
        "count": 1,
        "results": [
            {
                "price": {
                    "amount": 2999,
                    "currency": "CNY"
                },
                "title": "Example brand product",
                "is_tmall": true,
                "item_id_str": "TOKEN"
            }
        ]
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

3 optional filters available.

query string Required

Search words.

Example value coffee shops
page integer Optional

Only page 1 is available.

Example value 1
sort string Optional

default, price_asc or price_desc.

Example value relevance
site string Optional

Storefront: world, sg, my, th, jp or ca.

Example value example

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "count": 1,
        "results": [
            {
                "price": {
                    "amount": 2999,
                    "currency": "CNY"
                },
                "title": "Example brand product",
                "is_tmall": true,
                "item_id_str": "TOKEN"
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "tmall_search"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A parameter is invalid. Not billable.

{
    "message": "The request validation failed"
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.