获取优惠码列表
| 拥有此API的权限集 |
|---|
| 营销码券管理-查询 |
请求方式及url
- 请求方式：
POST - 请求头：
Content-Type:application/json - 接口地址：
https://api.xiaoe-tech.com/xe.promo_code.list/1.0.0 - 频率限制:
10秒3000次
在线调试工具
请求
响应
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| access_token | 是 | string | 专属token |
| ptype | 否 | int | 优惠码类型 0通用码,1专属码 |
| style | 否 | int | 优惠类型0全额抵扣,1满减,2折扣 |
| state | 否 | int | 状态0未上架，1进行中，10有效，11已失效 |
| name | 否 | string | 名称 |
| page_index | 否 | int | 页码 |
| page_size | 否 | int | 每页大小 |
请求示例
{
"access_token": "xe_xxxxx",
"ptype": 0,
"style": 0,
"state": 1,
"page_index": 1,
"page_size": 10
}
返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 返回码 |
| msg | string | 返回信息 |
| data | object | 返回值 |
| data.list | array | 优惠码列表 |
| data.total | int | 总数 |
data.list优惠码列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | int | 优惠码id |
| batch_id | string | 优惠码批次 |
| name | string | 优惠码名称 |
| ptype | int | 优惠码类型:0通用码,1专属码 |
| style | int | 优惠类型:0全额抵扣,1满减,2折扣 |
| min_charge | int | 使用门槛:0表示无门槛 |
| discount | int | 优惠额,若是折扣类表示百分比0-100 |
| total_num | int | 发放总量 |
| view_num | int | 查看总量 |
| use_num | int | 使用总量 |
| code | string | 通用码号:专属码会预生成码库 |
| note | string | 内部备注 |
| status | int | 状态:0有效1失效 |
| start_at | string | 开始时间 |
| end_at | string | 结束时间 |
| discount_limit | int | 折扣上限, 最多优惠金额【0表示不限制】 |
| state | int | 状态0未上架，1进行中，10有效，11已失效 |
| url | string | 分享链接 |
| short_url | string | 分享短链接 |
返回示例
{
"code": 0,
"msg": "获取成功",
"data": {
"list": [
{
"batch_id": "pc_itn79780_8HqGbhBPRkovBjwQuNXm2q",
"code": "brinco^",
"discount": 0,
"discount_limit": 0,
"end_at": "2022-08-28 00:00:00",
"id": 40229,
"min_charge": 0,
"name": "brainco",
"note": "",
"ptype": 0,
"start_at": "2021-08-25 11:28:42",
"state": 1,
"status": 0,
"style": 0,
"total_num": 102,
"use_num": 0,
"view_num": 0
}
],
"total": 2
}
}