获取优惠券领券用户2.0
| 拥有此API的权限集 |
|---|
| 营销码券管理-查询 |
请求方式及url
- 请求方式：
POST - 请求头：
Content-Type:application/json - 接口地址：
https://api.xiaoe-tech.com/xe.coupon.user_list/2.0.0 - 频率限制:
1秒20次
在线调试工具
请求
响应
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| access_token | 是 | string | 专属token |
| cou_id | 是 | string | 优惠券id |
| is_use | 否 | int | 优惠券使用状态:0=未使用 1=已使用 3=已作废 |
| created_at | 否 | string | 大于等于创建时间(YYYY-MM_DD HH:mm::ss) |
| order_by_receive | 否 | int | 0:根据id倒序, 1:根据领取时间倒叙 2：根据领取时间正序 |
| page | 是 | int | 页码 |
| page_size | 是 | int | 页面size，最大500 |
请求示例
{
"access_token": "xe_xxxxx",
"cou_id": "cou_61c57f24e7f20-YMPS9r",
"page":1,
"page_size":10
}
返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 返回码 |
| msg | string | 返回信息 |
| data | object | 返回值 |
| data.total | int | 总数 |
| data.list | object | 返回列表 |
data.list 返回列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | string | 用户领取的优惠券ID |
| app_id | string | app_id |
| cou_id | string | 优惠券批次ID |
| user_id | string | 用户ID |
| get_type | int | 领取类型 |
| receive_at | string | 领取时间 |
| valid_at | string | 有效时间 |
| invalid_at | string | 过期时间 |
| is_use | int | 是否已经使用 0未使用，1:已经使用, 3:已失效 |
| use_at | string | 使用时间，如果is_user=1则有值 |
| has_prompt | int | 是否已提醒用户 0-不需要提醒, 1-需要提醒, 2-已提醒 |
| receive_channel | string | 领取渠道, alive_take_goods=直播间领取 |
| receive_channel_id | string | 领取渠道资源ID, receive_channel=alive_take_goods时该字段为直播id |
| created_at | string | 领券时间 |
| updated_at | string | 记录更新时间 |
| resource_id | string | 使用的资源ID |
| resource_type | int | 使用的资源类型 |
| order_id | string | 订单号 |
| is_gift_coupon | int | 优惠劵类型 0:优惠券 1:礼品券 2:兑换券 |
返回示例
{
"code": 0,
"msg": "OK",
"data": {
"list": [
{
"app_id": "appxxxx",
"cou_id": "cou_xxxx",
"created_at": "2021-12-29 10:18:31",
"get_type": 0,
"has_prompt": 0,
"id": "cu_xxxx",
"invalid_at": "2021-12-29 23:59:59",
"is_use": 0,
"order_id": "",
"receive_at": "2021-12-29 10:18:31",
"resource_id": "",
"resource_type": 0,
"updated_at": "2021-12-29 10:18:31",
"use_at": "",
"receive_channel": "alive_take_goods",
"receive_channel_id": "l_xxxx",
"user_id": "u_xxxx",
"valid_at": "2021-12-29 10:18:31",
"is_gift_coupon":0,
}
],
"total": 1
}
}