Appearance

优惠券列表 ​

拥有此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端资源详情页优惠券的展示``
coupon_type否array优惠券类型，1-通用优惠券,2-专属优惠券,3-员工优惠券,6-礼品券,7-兑换券若需要查全部类型的券，对应值为 [1,2,3,6,7]
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-员工优惠券,6-礼品券,7-兑换券
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字符串

参数名类型说明备注（示例）
idstring关联id
titlestring冗余标题
is_free_vipbool是否是体验会员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
    }
}