Product Rankings - Sales Volume Rankings

Introduction

Retrieve product sales volume rankings data, with the following features:

• Supports filtering parameters
• Supports custom result sorting

API Endpoint

    POST /product/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
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)
gmv	No	Revenue (descending)
total_units_sold	No	Total sales volume (descending)
total_gmv	No	Total revenue (descending)
growth_rate	No	Growth rate (descending)

Request Example

curl 'https://openapi.test.fastmoss.com/product/v1/rank/topSales?client_id=XXX&timestamp=XXX&access_token=XXX&sign=XXX' \
--header 'Content-Type: application/json' \
{
    "filter": {
        "region": "US",
        "product_category": 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": "gmv",
        "order": "desc",
      }
    ],
    "page": 1,
    "pagesize": 10
}

Response Body

data.total

• Type: integer
• Description: Total number of results

data.list

Field	Type	Description
product_id	string	Product ID
title	string	Product title
region	string	Country/Region
cover	string	Product cover URL
category	object	Product category
commission_rate	integer	Commission rate
price	string	Product price
units_sold	integer	Sales volume
gmv	integer	Revenue
total_units_sold	integer	Total sales volume
total_gmv	integer	Total revenue
growth_rate	integer	Sales growth rate
shop	object	Shop information

data.list.shop

Field	Type	Description
seller_id	string	Shop ID
name	string	Shop name
avatar	string	Shop cover URL
total_units_sold	integer	Shop total sales volume

Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "total": 500,
    "list": [
      {
        "product_id": "1729537665891078575",
        "title": "33.81oz Glass Water Cup, Large Glass Cup with Lid & Straw, Drinking Cup for Home Office Use, Drinkware Gift Ideas, Kitchen Accessories",
        "cover": "https://s.500fd.com/tt_product/16e26aec1fb94e3784665b5b2ecfe0e0~tplv-dx0w9n1ysr-resize-jpeg:800:800.jpeg",
        "price": "$10.94",
        "region": "US",
        "commission_rate": 1234,
        "category": {
          "l1":{"id":123,"name":"test"}, 
          },

          "units_sold":123,
          "gmv":123,
          "total_units_sold":123,
          "total_gmv":123,
          "growth_rate":123,

          "shop":{
            "seller_id":123,
            "name":"test",
            "avatar":"xxx",  
            "total_units_sold":123,
          }
      }
    ]
  }
}