商品榜单-销量榜

简介

获取商品销量榜单数据，支持以下功能：

• 支持设置过滤参数
• 支持自定义结果排序方式

接口

    POST /product/v1/rank/topSales

request body

字段	类型	必选	描述
filter	object	否	过滤参数
orderby	object	否	排序参数
page	integer	否	页码，默认值：1
pagesize	integer	否	每页条数，默认值：10

filter 可选值

字段	类型	必选	描述
region	string	否	国家/地区，例如：['US', 'GB', 'MX', 'ES', 'ID', 'VN', 'MY', 'TH', 'PH']
category_id	integer	否	商品分类
date_info	object	否	日期信息，例如：{'type': 'day', 'value': '2025-02-01'}

orderby 可选值

字段	必选	描述
units_sold	否	销量（降序）
gmv	否	销售额（降序）
total_units_sold	否	总销售量（降序）
total_gmv	否	总销售额（降序）
growth_rate	否	增长率（降序）

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": "follower_inc_count",
        "order": "desc",
      }],
    "page": 1,
    "pagesize": 10
}

response body

data.total

• 类型：integer
• 描述：结果总条数

data.list

字段	类型	描述
product_id	string	商品 ID
title	string	商品标题
region	string	国家/地区
cover	string	商品封面 URL
category	object	商品分类
commission_rate	integer	佣金比例
price	string	商品价格
units_sold	integer	销量
gmv	integer	销售额
total_units_sold	integer	总销量
total_gmv	integer	总销售额
growth_rate	integer	销量环比增长率
shop	object	店铺信息

data.list.shop

字段	类型	描述
seller_id	string	店铺 ID
name	string	店铺名称
avatar	string	店铺封面 URL
total_units_sold	integer	店铺总销量

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": "cover url",
        "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,
          }
      }
    ]
  }
}