优惠券-营销统计详细

优惠券 - 获取单个优惠券统计信息

接口信息

  • 接口地址: {your-site-url}/api/skill/coupon/get-coupon-statistics
  • 基础 URL: {your-site-url} 需替换为你自己的独立站 URL 地址,如 https://your-domain.com/apimanager666
  • 请求方式: GET
  • 说明: 此接口用于获取指定优惠券的统计数据,以及使用该优惠券的订单列表。

认证

请求头中需要携带 skill-access-token

Header
skill-access-token {your-skill-access-token} (请替换为你自己的 token)

请求参数 (Query String)

字段 类型 必填 说明
coupon_id int 优惠券 ID
pageNum int 页码,默认 1
pageSize int 每页条数,默认 20

请求示例

cURL

curl --location --request GET '{your-site-url}/api/skill/coupon/get-coupon-statistics?pageNum=1&pageSize=20&coupon_id=69' \
--header 'skill-access-token: {your-skill-access-token}'

返回结果

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

成功响应

{
    "code": 200,
    "data": {
        "statistics_info": {
            "tem_use_count": 0,
            "used_count": 2,
            "base_discount_amount": "20.00",
            "base_order_amount": "2728.25",
            "order_product_count": 6,
            "average_unit_amount": "1364.13",
            "average_product_count": "3.00"
        },
        "order_info": {
            "list": [
                {
                    "order_number": "FECE604389850873072",
                    "customer_email": "fecify@126.com",
                    "payment_status": 3,
                    "updated_at": "2026-06-04 10:09:47",
                    "items_count": 1,
                    "base_grand_total": "2051.50",
                    "coupon_use_status": 2,
                    "coupon_discount_base_amount": "10.00"
                }
            ],
            "total": 2,
            "pageSize": 20,
            "totalPage": 1
        }
    },
    "message": "success"
}

返回字段说明

字段 类型 说明
code Number 状态码,200 表示成功
message String 执行结果的文字描述
data.statistics_info Object 优惠券统计数据
data.order_info Object 使用该优惠券的订单列表(分页)

statistics_info 字段

字段 类型 说明
tem_use_count int 已占用的个数。订单已使用该优惠券但尚未完成支付(未召回订单)
used_count int 已使用的个数。订单已完成支付(已召回订单)
base_discount_amount string 优惠总金额(基础货币)。已召回订单的优惠金额总和
base_order_amount string 订单总金额(基础货币)。已召回订单的订单总额
order_product_count int 订单商品总件数。已召回订单的商品件数总和
average_unit_amount string 平均客单价。已使用此优惠券的累计订单总额 ÷ 订单总数
average_product_count string 平均客单件。已使用此优惠券的累计商品数量 ÷ 订单总数

order_info.list 子项字段

字段 类型 说明
order_number string 订单编号
customer_email string 客户邮箱
payment_status int 支付状态。1 = 初始状态,2 = 待支付,21 = 等待支付审核,3 = 已支付,4 = 已部分退款,5 = 已全部退款
updated_at string 最后更新时间
items_count int 订单商品个数
base_grand_total string 订单总金额(基础货币)
coupon_use_status int 优惠券使用状态。1 = 订单已占用该优惠券但尚未完成支付(订单未召回),2 = 订单已完成支付(订单已召回,recall_status = 3
coupon_discount_base_amount string 该优惠券在本订单中优惠的金额(基础货币)

order_info 分页字段

字段 类型 说明
total int 订单总数
pageSize int 每页条数
totalPage int 总页数

注意事项

  1. statistics_info 中各类金额均为基础货币
  2. average_unit_amount = base_order_amount ÷ used_countaverage_product_count = order_product_count ÷ used_count
  3. coupon_use_status = 1 的订单为未召回订单,coupon_use_status = 2 的订单为已召回订单
Copyright © fecify.com 2025 all right reserved,powered by Gitbook该文件修订时间: 2026-06-04 10:42:17

results matching ""

    No results matching ""