店铺-商品-销售统计

接口信息

  • 接口地址: {your-site-url}/api/skill/data/get-product-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-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}'

返回结果

code200 表示调用成功;code 不为 200 表示调用失败。

成功响应

{
    "code": 200,
    "data": {
        "list": [
            {
                "product_id": 7043,
                "product_sale_count": "3",
                "product_sale_amount": "237.00",
                "product_info": {
                    "id": 7043,
                    "title": "Diamond Detail In Gold Vermeil",
                    "status": 1,
                    "is_deleted": 2,
                    "image": {
                        "id": 40979,
                        "product_id": 7043,
                        "src": "/product/15/image/2026/05/23/c95f68bbf27f44d98b6882e6d8a1a301.jpg",
                        "width": 840,
                        "height": 1100,
                        "ratio": "0.76",
                        "alt": "",
                        "position": 1,
                        "created_at": 1779537993,
                        "updated_at": 1779537993
                    }
                }
            }
        ],
        "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
product_sale_count string 商品的销售个数
product_sale_amount string 商品的销售金额
product_info Object 商品基本信息

product_info 字段

字段 类型 说明
id int 商品 ID
title string 商品标题
status int 商品状态。1 = 上架,2 = 下架
is_deleted int 是否软删除。1 = 是,2 = 否
image Object 商品主图信息

product_info.image 字段

字段 类型 说明
id int 图片 ID
product_id int 商品 ID
src string 商品主图路径。可能是完整 URL 或相对路径,相对路径时完整 URL = attachment_url + srcattachment_url得到网站基础URL 获取)
width int 图片宽度
height int 图片高度
ratio string 图片宽高比
alt string 图片 alt 文本
position int 图片排序位置
created_at int 创建时间戳
updated_at int 更新时间戳

注意事项

  1. 默认按 product_sale_count(销量)降序排列
  2. sort 可为 product_sale_countproduct_sale_amount
  3. directionascdesc
  4. begin_dateend_date 格式为 YYYY-MM-DD HH:mm:ss
Copyright © fecify.com 2025 all right reserved,powered by Gitbook该文件修订时间: 2026-06-04 18:57:15

results matching ""

    No results matching ""