优惠券列表

拥有此API的权限集
营销码券管理-查询

请求方式及url

请求方式：POST
请求头：Content-Type:application/json
接口地址：https://api.xiaoe-tech.com/xe.coupon.list/2.0.0
频率限制：10秒500次

在线调试工具

请求

响应

请求参数

参数名	必选	类型	说明	备注
access_token	是	string	专属token	`...`
start_time	否	date	有效期开始时间	`...`
end_time	否	date	有效期结束时间	`...`
coupon_name	否	string	优惠券名称	支持模糊查找
discount_type	否	int	优惠券类型 0 全部 1-满减券 2-折扣券	``
coupon_ids	否	string/array	优惠券ID集合	`xxxx`
spread_type	否	int/array	领取方式 0-用户领取 1-商家发放 2-兑换码兑换 3-不限
select_state	否	array	状态 1-领取中 2-已领完 3-已结束, 支持多个状态	`1`
activity_state	否	string/array	活动状态 0-不限 1-（未开始 - 能领不能用） 2-（进行中 - 能领能用） 3-（已结束 - 不能领不能用） 4-(已停止 - 不能领能用）	``
user_id	否	string	用户user_id	``
is_show	否	int	是否在详情页展示 0-不展示 1-展示；影响c端资源详情页优惠券的展示	``
page	否	int	页码	`1`
page_size	否	int	页目条数	`10`
start_update_time	否	string	查询update_time范围的开始时间，如2022-09-06 00:00:00	``
end_update_time	否	string	查询update_time范围的结束时间，如2022-09-07 00:00:00	``

请求示例

{
       "access_token":"xe_xxxxx",
}

返回参数

参数名	必选	类型	说明	备注（示例）
code	是	int	请求结果码
msg	是	string	描述信息	无
data	是	array	数据	无

数据列表data

参数名	必选	类型	说明	备注（示例）
id	是	string	优惠券标识
title	是	int	优惠券名称
type	是	int	优惠券类型	0-商品优惠券 1-全店优惠券
discount_way	是	int	优惠方式	1-满减券 2-折扣券
discount_percent	是	int	折扣力度	0-100，0表示非折扣优惠券
discount_limit_price	是	int	折扣上限	单位：分
can_del_since	是	string	优惠券失效后可以删除的时间
surplus_count	是	int	可用库存
spread_type	是	int	发放方式	0-用户领取 1-商家发放 2-兑换码兑换
price	是	int	金额	单位：分
bind_res_count	是	int	绑定资源数
require_price	是	int	最低消费金额	单位：分
valid_at	是	string	有效开始时间
invalid_at	是	string	有效结束时间
valid_after	是	int	领取生效字段	-1 取优惠券生效时间；0 当天生效； 1 次日生效
valid_day	是	int	领取后有效天数
manual_stop_at	是	string	手动结束时间结束了不能再领取，但领取了的能使用
receive_rule	是	int	每人限领次数	0-不限制
count	是	int	总发放量
has_received	是	int	已领取总数
can_share	是	int	是否可以进行h5分享
coupon_type	是	int	优惠券类型，1-通用优惠券,2-专属优惠券,3-员工优惠券
receive_limit_type	是	int	限制身份领取类型 0-不限制,1-超级会员,2-用户人群,3-用户标签
receive_limit_ids	是	string	领取限制关联ID,为Json字符串
instructions	是	string	优惠券使用说明
limit_title	是	string	指定身份文本
has_relate_paid_coupon	是	bool	是否关联有价优惠券 ,true-关联 ;false-不关联
has_spread_process_state	是	bool	优惠券是否有进行中的定向发放	1-有 0-无
is_use	是	int	已使用总数	旧
use_count	是	int	已使用总数
coupon_state	是	int	优惠券状态	1-领取中 2-已领完 3-已结束 4 已失效 5 未开始
activity_state	是	int	优惠券活动状态	1-（未开始 - 能领不能用） 2-（进行中 - 能领能用） 3-（已结束 - 不能领不能用） 4-(已停止 - 不能领能用）5-(已冻结，不能领不能用)
activity_exception_msg	是	string	活动异常提示	""

receive_limit_ids领取限制关联ID的Json字符串

参数名	类型	说明	备注（示例）
id	string	关联id
title	string	冗余标题
is_free_vip	bool	是否是体验会员	true

返回示例

 {
    "code": 0,
    "msg": "",
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": "cou_xxxwcB",
                "title": "xxx",
                "type": 1,
                "discount_way": 1,
                "discount_percent": 0,
                "discount_limit_price": 0,
                "spread_type": 3,
                "price": 23322,
                "bind_res_count": 0,
                "require_price": 0,
                "valid_at": "2021-08-28 00:00:00",
                "invalid_at": "2021-08-31 00:00:00",
                "valid_after": -1,
                "valid_day": 0,
                "manual_stop_at": null,
                "receive_rule": 0,
                "count": 2,
                "has_received": 0,
                "can_share": 1,
                "coupon_type": 1,        
                "receive_limit_type": 0,    
                "receive_limit_ids": "",    
                "instructions": "",    
                "limit_title": "xxxx",    
                "has_relate_paid_coupon": false,
                "has_spread_process_state": 0,
                "is_use": 0,
                "use_count": 0,
                "coupon_state": 1,
                "activity_exception_msg": "",
                "activity_state": 1,
                "can_del_since": "",
                "surplus_count": 2        
            }
        ],
        "from": 1,
        "last_page": 518,
        "next_page_url": "http://xxxx",
        "path": "http://xxxx",
        "per_page": 10,
        "prev_page_url": null,
        "to": 10,
        "total": 5171
    }
}

优惠券列表

优惠券列表

请求

响应

results matching ""

No results matching ""