优惠券-列表-全部
优惠券 - 获取优惠券列表
接口信息
- 接口地址:
{your-site-url}/api/skill/coupon/list
- 基础 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)
| 字段 |
类型 |
必填 |
说明 |
title |
string |
否 |
优惠券标题,LIKE 模糊搜索 |
code |
string |
否 |
优惠券码,LIKE 模糊搜索 |
activity_status |
int |
否 |
活动状态。1 = 未开始,2 = 进行中,3 = 已结束 |
created_at_begin |
string |
否 |
创建时间区间 - 开始时间 |
created_at_end |
string |
否 |
创建时间区间 - 结束时间 |
pageNum |
int |
否 |
页码,默认 1 |
pageSize |
int |
否 |
每页条数,默认 20 |
请求示例
cURL
curl --location --request GET '{your-site-url}/api/skill/coupon/list' \
--header 'skill-access-token: {your-skill-access-token}'
带搜索条件:
curl --location --request GET '{your-site-url}/api/skill/coupon/list?title=terry&activity_status=2&pageNum=1&pageSize=20' \
--header 'skill-access-token: {your-skill-access-token}'
返回结果
code 为 200 表示调用成功;code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": {
"list": [
{
"id": 70,
"shop_id": 15,
"status": 1,
"title": "terry coupon",
"code": "LX4ABQ14",
"usage_count": 0,
"value_type": 1,
"value": "10.00",
"usage_count_per_customer": 0,
"usage_limit": 0,
"starts_at": "2026-06-03 20:50:03",
"ends_at": 0,
"product_selection_type": 2,
"minimum_requirements_type": 2,
"created_at": "2026-06-03 20:51:44",
"updated_at": "2026-06-03 20:51:44",
"prerequisite_subtotal": "50.00",
"prerequisite_quantity": 0,
"activity_status": 2
}
],
"total": 43,
"pageSize": 20,
"totalPage": 3
},
"message": "success"
}
返回字段说明
| 字段 |
类型 |
说明 |
code |
Number |
状态码,200 表示成功 |
message |
String |
执行结果的文字描述 |
data.list |
Array[Object] |
优惠券列表 |
data.total |
int |
优惠券总数 |
data.pageSize |
int |
每页条数 |
data.totalPage |
int |
总页数 |
list 子项字段
| 字段 |
类型 |
说明 |
id |
int |
优惠券 ID |
shop_id |
int |
店铺 ID |
status |
int |
状态。1 = 激活,2 = 关闭 |
title |
string |
优惠券标题 |
code |
string |
优惠券码 |
usage_count |
int |
已被使用的次数 |
value_type |
int |
折扣类型。1 = 固定金额,2 = 百分比 |
value |
string |
折扣值 |
usage_count_per_customer |
int |
每顾客最大使用次数。0 = 无限制 |
usage_limit |
int |
总使用次数上限。0 = 无限制 |
starts_at |
string |
生效时间 |
ends_at |
int |
结束时间。0 表示不限时 |
product_selection_type |
int |
适用商品选择类型。1 = 全部,2 = 指定商品,3 = 指定专辑 |
minimum_requirements_type |
int |
最低要求类型。1 = 无限制,2 = 最低金额,3 = 最低数量 |
prerequisite_subtotal |
string |
最低购买金额 |
prerequisite_quantity |
int |
最低购买数量 |
activity_status |
int |
活动状态。1 = 未开始,2 = 进行中,3 = 已结束 |
created_at |
string |
创建时间 |
updated_at |
string |
最后更新时间 |
注意事项
activity_status 根据当前时间与 starts_at、ends_at 动态计算
title 和 code 为 LIKE 模糊匹配
created_at_begin 和 created_at_end 配合使用,按创建时间范围筛选