获取兑换码码库列表
拥有此API的权限集 |
---|
营销码券管理-查询 |
请求方式及url
- 请求方式:
POST
- 请求头:
Content-Type:application/json
- 接口地址:
https://api.xiaoe-tech.com/xe.redeem_code.storage_list/1.0.0
- 频率限制:
10秒3000次
在线调试工具
请求
响应
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
access_token | 是 | string | 专属token |
batch_id | 是 | string | 批次id |
activity_id | 是 | string | 活动id |
state | 否 | int | 状态0,全部状态,1已兑换,2未兑换,3已作废 |
code | 否 | string | 兑换码号搜索 |
page_index | 否 | string | 页码 |
page_size | 否 | string | 每页大小,默认10,最大100 |
请求示例
{
"access_token":"xe_xxxxx",
"activity_id":"ma_rd_61caf431d4f81_9rwq64Bu",
"batch_id":"dT",
"state":0,
"page_size":1,
"page_index":1
}
返回参数
参数名 | 类型 | 说明 |
---|---|---|
code | int | 返回码 |
msg | string | 返回信息 |
data | object | 兑换码信息 |
data
兑换码信息
参数名 | 类型 | 说明 |
---|---|---|
app_id | string | 店铺id |
batch_id | string | 批次id |
title | string | 兑换码名称 |
activity_id | string | 兑换码活动id |
total | int | 兑换码生成个数 |
used | int | 已兑换总数 |
redeem_user_count | int | 已兑换用户总数 |
use_limit | int | 兑换码每人可用次数,0不限制 |
start_at | string | 开始时间 |
end_at | string | 结束时间 |
is_long_term | int | 是否长期有效 0-否,1-是 |
manual_at | string | 手动结束的时间 |
created_at | string | 创建时间 |
state | int | 兑换码的状态 |
code_list | array | 兑换码码库信息 |
code_list
兑换码码库信息
参数名 | 类型 | 说明 |
---|---|---|
redeem_code | string | 码号 |
user_id | string | 使用的用户id |
created_at | string | 创建时间 |
used_at | string | 使用时间 |
state | int | 使用状态1已兑换,2未兑换,3已作废 |
user_name | string | 使用用户名称 |
order_ids | array | 使用后生成的订单 |
返回示例
{
"code": 0,
"msg": "OK",
"data": {
"activity_id": "ma_rd_61caf431d4f81_9rwq64Bu",
"app_id": "appxxxx",
"batch_id": "dT",
"code_list": [
{
"created_at": "2021-12-28 19:25:37",
"order_ids": [
"o_1640691152_61caf5d0ebb65_43895479"
],
"redeem_code": "dT2cs2rg",
"state": 1,
"used_at": "2021-12-28 19:32:32",
"user_id": "u_607fd4d248537_8rkScrKVND",
"user_name": "Ryan"
}
],
"created_at": "2021-12-28 19:25:37",
"end_at": "2021-12-31 12:00:00",
"is_long_term":0,
"manual_at": null,
"redeem_user_count": 1,
"start_at": "2021-12-28 19:25:26",
"state": 0,
"title": "1111",
"total": 111,
"use_limit": 0,
"used": 2
}
}