店铺-商品变体-销售统计
数据 - 获取商品变体销售排行
接口信息
- 接口地址:
{your-site-url}/api/skill/data/get-product-variant-ranking-data
- 基础 URL:
{your-site-url} 需替换为你自己的独立站 URL 地址,如 https://your-domain.com/apimanager666
- 请求方式:
GET
- 说明: 此接口用于获取商品变体(规格)维度的销售排行数据。仅 B2C 店铺支持,B2B 店铺不支持。与商品排行不同,此接口按变体维度统计。默认按销量降序排列,支持排序和分页。
认证
请求头中需要携带 skill-access-token:
| Header |
值 |
skill-access-token |
{your-skill-access-token} (请替换为你自己的 token) |
请求参数 (Query String)
| 字段 |
类型 |
必填 |
说明 |
quantum |
string |
是 |
统计维度。day = 按日,month = 按月,year = 按年 |
begin_date |
string |
是 |
统计时间区间 - 开始时间,格式 YYYY-MM-DD HH:mm:ss |
end_date |
string |
是 |
统计时间区间 - 结束时间,格式 YYYY-MM-DD HH:mm:ss |
sort |
string |
否 |
排序字段。product_sale_count = 按销量排序,product_sale_amount = 按销售金额排序。默认按 product_sale_count 降序 |
direction |
string |
否 |
排序方向。asc = 升序,desc = 降序。默认 desc |
pageNum |
int |
否 |
页码,默认 1 |
pageSize |
int |
否 |
每页条数,默认 20 |
请求示例
cURL
curl --location --request GET '{your-site-url}/api/skill/data/get-product-variant-ranking-data?quantum=month&begin_date=2026-05-05 07:54:31&end_date=2026-06-04 07:54:31' \
--header 'skill-access-token: {your-skill-access-token}'
返回结果
code 为 200 表示调用成功;code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": {
"list": [
{
"product_id": 7043,
"variant_id": 48958,
"product_sale_count": "3",
"product_sale_amount": "237.00",
"product_info": {
"id": 48958,
"product_id": 7043,
"title": "Diamond Detail In Gold Vermeil M / Black",
"image_id": 40979,
"image": {
"id": 40979,
"src": "/product/15/image/2026/05/23/c95f68bbf27f44d98b6882e6d8a1a301.jpg"
},
"status": 1,
"is_deleted": 2
}
}
],
"total": 7,
"pageSize": 20,
"totalPage": 1
},
"message": "success"
}
返回字段说明
| 字段 |
类型 |
说明 |
code |
Number |
状态码,200 表示成功 |
message |
String |
执行结果的文字描述 |
data.list |
Array[Object] |
变体排行列表 |
data.total |
int |
变体总数 |
data.pageSize |
int |
每页条数 |
data.totalPage |
int |
总页数 |
list 子项字段
| 字段 |
类型 |
说明 |
product_id |
int |
商品 ID |
variant_id |
int |
变体 ID |
product_sale_count |
string |
该变体的销售个数 |
product_sale_amount |
string |
该变体的销售金额 |
product_info |
Object |
变体基本信息 |
product_info 字段
| 字段 |
类型 |
说明 |
id |
int |
变体 ID |
product_id |
int |
商品 ID |
title |
string |
变体标题(含商品名和规格名) |
image_id |
int |
变体图片 ID |
status |
int |
商品状态。1 = 上架,2 = 下架 |
is_deleted |
int |
是否软删除。1 = 是,2 = 否 |
image |
Object |
变体图片信息 |
product_info.image 字段
| 字段 |
类型 |
说明 |
id |
int |
图片 ID |
src |
string |
图片路径。可能是完整 URL 或相对路径,相对路径时完整 URL = attachment_url + src(attachment_url 从 得到网站基础URL 获取) |
注意事项
- 与 店铺-商品-销售统计 不同,此接口按变体维度统计,一个商品的多个变体会分别列出
- 默认按
product_sale_count(销量)降序排列
sort 可为 product_sale_count 或 product_sale_amount
direction 为 asc 或 desc
begin_date 和 end_date 格式为 YYYY-MM-DD HH:mm:ss