版本：202506
查询优惠券列表
GET/openapi/2025-06/coupons
分页获取系统中可用的优惠券列表。
请求
Query参数
not_started: 未开始ongoing: 进行中finished: 已结束fixed_amount: 固定金额折扣percentage: 百分比折扣voucher: 代金券
cursor string
分页游标
page_size int32
每页记录数
progress string
按优惠券进度筛选：
type string
按优惠券类型筛选：
keyword string
搜索关键词
响应
- 200
OK
- application/json
- 数据结构
- 示例
数据结构
- Array [
ongoing: 进行中not_started: 未开始finished: 已结束- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
codestring
错误码
messagestring
错误信息
data object
coupons object[]
优惠券列表
idstring
优惠券 ID
store_idint32
折扣适用的店铺 ID
life_cycle_typestring
折扣的生命周期类型，可为 begin_end 或 survival
survival_timestring
有效时间（秒），适用于 life_cycle_type=survival
starts_atstring
折扣开始时间（Unix 时间）
ends_atstring
折扣结束时间（Unix 时间），-1 表示无截止日期
discount_typestring
折扣类型
value_typestring
折扣值类型
valuestring
折扣值（如折扣率或固定减免金额）。当折扣由 prerequisite_subtotal_range 或 prerequisite_quantity_range 中的阈值规则决定时，此字段为 0
usage_limitint32
折扣的最大使用次数，-1 表示无限制
once_per_customerint32
单个顾客可使用折扣的最大次数
titlestring
折扣的标题或名称
stockint32
折扣的剩余库存或可用量
target_selectionstring
目标范围（如 all 表示所有商品）
codestring
折扣码
prerequisiteint32
折扣是否有前提条件（1 为是，0 为否）
is_admin_showint32
折扣在管理后台是否可见（1 为是，0 为否）
progressstring
优惠券进度状态，请使用此字段而非 status：
allocation_limit_amountstring
折扣的最大分配上限金额
prerequisite_quantity_range object[]
折扣的数量范围前提条件
greater_than_or_equal_tostring
大于或等于的值
valuestring
值
value_percentagestring
百分比值
value_event_typestring
值事件类型
value_conditionstring
值条件
target_typestring
目标类型
target_datastring[]
目标数据
prerequisite_subtotal_range object[]
折扣的小计金额范围前提条件
greater_than_or_equal_tostring
大于或等于的值
valuestring
值
value_percentagestring
百分比值
value_event_typestring
值事件类型
value_conditionstring
值条件
target_typestring
目标类型
target_datastring[]
目标数据
entitled_product_idsstring[]
折扣授权的商品 ID 列表
entitled_variant_idsstring[]
折扣授权的规格 ID 列表
entitled_sortstring[]
授权商品的排序方式
times_usedint32
折扣已使用次数
sort object
折扣的排序配置
bystring
排序字段
directionstring
排序方向
use_with_otherint32
折扣是否可与其他折扣叠加使用（1 为是，0 为否）
prerequisite_customer_idsstring[]
符合折扣条件的顾客 ID 列表
prerequisite_customer_segment_idsstring[]
符合折扣条件的顾客分组 ID 列表
config object
折扣配置，包括横幅和倒计时设置
banner_urlstring
横幅图片 URL
banner_sizestring
横幅尺寸
count_down object
倒计时样式设置
show_count_downboolean
是否显示倒计时
formatstring
倒计时显示格式
background_color_startstring
背景渐变起始颜色
background_color_endstring
背景渐变结束颜色
colorstring
倒计时文字颜色
count_down_background_colorstring
倒计时背景颜色
count_down_colorstring
倒计时颜色
detail_page_show_codeboolean
详情页显示代码
landing_page_show_codeint32
落地页显示代码
allocation_methodstring
折扣的分配方式
allocation_limitint32
折扣的分配上限
customer_selectionstring
折扣的顾客筛选条件
entitled_collection_idsstring[]
折扣授权的集合 ID 列表
tips object
与折扣关联的提示和消息
msgstring
消息
countdownstring
倒计时
countdown_daystring
倒计时天数
use_codestring
使用码
copy_codestring
复制码
entitled_extra_list object[]
折扣的附加授权数据
idstring
ID
sortint32
排序配置
discount_channel_list object[]
折扣渠道列表
channel_typestring
渠道类型
channel_statusint32
渠道状态
location_idsstring[]
位置 ID 列表
only_valid_first_order_customerboolean
折扣是否仅对首次下单顾客有效
target_price_typestring
目标价格类型
remarksstring
备注信息
coupon_typestring
优惠券类型
channel_messagestring
渠道消息
coupon_messagestring
优惠券提示信息
send_target_selectionstring
发送目标选择
effective_timestring
生效时间
use_coupon_starts_atstring
优惠券使用开始时间
use_coupon_ends_atstring
优惠券使用结束时间
cursorstring
分页游标
has_moreboolean
是否有更多记录
{
"code": "string",
"message": "string",
"data": {
"coupons": [
{
"id": "string",
"store_id": 0,
"life_cycle_type": "string",
"survival_time": "string",
"starts_at": "string",
"ends_at": "string",
"discount_type": "string",
"value_type": "string",
"value": "string",
"usage_limit": 0,
"once_per_customer": 0,
"title": "string",
"stock": 0,
"target_selection": "string",
"code": "string",
"prerequisite": 0,
"is_admin_show": 0,
"progress": "string",
"allocation_limit_amount": "string",
"prerequisite_quantity_range": [
{
"greater_than_or_equal_to": "string",
"value": "string",
"value_percentage": "string",
"value_event_type": "string",
"value_condition": "string",
"target_type": "string",
"target_data": [
"string"
]
}
],
"prerequisite_subtotal_range": [
{
"greater_than_or_equal_to": "string",
"value": "string",
"value_percentage": "string",
"value_event_type": "string",
"value_condition": "string",
"target_type": "string",
"target_data": [
"string"
]
}
],
"entitled_product_ids": [
"string"
],
"entitled_variant_ids": [
"string"
],
"entitled_sort": [
"string"
],
"times_used": 0,
"sort": {
"by": "string",
"direction": "string"
},
"use_with_other": 0,
"prerequisite_customer_ids": [
"string"
],
"prerequisite_customer_segment_ids": [
"string"
],
"config": {
"banner_url": "string",
"banner_size": "string",
"count_down": {
"show_count_down": true,
"format": "string",
"background_color_start": "string",
"background_color_end": "string",
"color": "string",
"count_down_background_color": "string",
"count_down_color": "string",
"detail_page_show_code": true,
"landing_page_show_code": 0
}
},
"allocation_method": "string",
"allocation_limit": 0,
"customer_selection": "string",
"entitled_collection_ids": [
"string"
],
"tips": {
"msg": "string",
"countdown": "string",
"countdown_day": "string",
"use_code": "string",
"copy_code": "string"
},
"entitled_extra_list": [
{
"id": "string",
"sort": 0
}
],
"discount_channel_list": [
{
"channel_type": "string",
"channel_status": 0,
"location_ids": [
"string"
]
}
],
"only_valid_first_order_customer": true,
"target_price_type": "string",
"remarks": "string",
"coupon_type": "string",
"channel_message": "string",
"coupon_message": "string",
"send_target_selection": "string",
"effective_time": "string",
"use_coupon_starts_at": "string",
"use_coupon_ends_at": "string"
}
],
"cursor": "string",
"has_more": true
}
}