Shop Rankings - Sales Volume Rankings

Introduction

Retrieve TikTok shop sales volume rankings data, with the following features:

• Supports filtering parameters
• Supports custom result sorting

API Endpoint

    POST /shop/v1/rank/topSales

Request Body

Field	Type	Required	Description
filter	object	No	Filter parameters
orderby	object	No	Sorting parameters
page	integer	No	Page number, default: 1
pagesize	integer	No	Items per page, default: 10

filter Optional Values

Field	Type	Required	Description
region	string	No	Country/Region, e.g., ['US', 'GB', 'MX', 'ES', 'ID', 'VN', 'MY', 'TH', 'PH']
category_id	integer	No	Product category (Level 1)
date_info	object	No	Date info, e.g., {'type': 'day', 'value': '2025-02-01'}

orderby Optional Values

Field	Required	Description
units_sold	No	Sales volume (descending)

Request Example

curl 'https://openapi.test.fastmoss.com/shop/v1/rank/topSales?client_id=XXX&timestamp=XXX&access_token=XXX&sign=XXX' \
--header 'Content-Type: application/json' \
{
    "filter": {
        "region": "US",
        "category_id": 1,
        "date_info": {
            "type": "day",
            "value": "2023-02-01"
        },
        # "date_info": {
        #     "type": "week",
        #     "value": "2023-18"
        # },
        # "date_info": {
        #     "type": "month",
        #     "value": "2023-02"
        # }
    },
    "orderby": [
      {
        "field": "units_sold",
        "order": "desc",
      }],
    "page": 1,
    "pagesize": 10
}

Response Body

data.total

• Type: integer
• Description: Total number of results

data.list

Field	Type	Description
seller_id	string	Shop ID
name	string	Shop name
avatar	string	Shop logo URL
category	array[object]	Main categories
region	string	Country/Region
units_sold	integer	Sales volume
gmv	integer	Revenue
product_count	integer	Product count
video_count	integer	Associated video count
creator_count	integer	Associated creator count

Response Example

{
    "code":0,
    "msg":"success", 
    "data":{
        "total":500,
        "list":[
                {
                    "rank":1,
                    "seller_id":"123",
                    "name":"helo",
                    "avatar":"xxx",
                    "category":[{"id":1,"name":"test"}],
                    "region":"US",
                    "units_sold":123,
                    "gmv":100,
                    "product_count":12,
                    "video_count":12,
                    "creator_count":10,
                }
            ]
        }
}