用户可用代金券列表
更新时间：2025-04-01
接口说明
用户可用代金券列表
请求URI
POST /api/bes/cluster/coupon/avail
请求头参数
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| x-Region | String | 是 | 区域 | bd |
响应体参数
响应体字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| success | Boolean | 请求是否成功 | true |
| status | Integer | 状态码 | 200 |
| result | Result | 代金券结果 |
Result字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| coupons | List |
代金券数据 |
CouponsItem字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| id | BigDecimal | 代金券id | 1189112 |
| name | String | 代金券号 | DN1EIM18VLLYBN8 |
| couponType | String | 优惠券类型 | CASH_COUPON |
| productType | String | 产品类型 | COMMON |
| productTypes | List |
多产品类型 | ["COMMON"] |
| productRuleDescription | String | 产品描述 | 通用（除域名/短信/专线/商标知产/证书/工商财税） |
| totalAmount | BigDecimal | 总额 | 500.0 |
| balance | String | 余额 | 500.00 |
| amountOrDiscount | String | 金额/折扣 | 500.00 |
| usedAmount | String | 已使用金额 | |
| beginTime | BigDecimal | 生效时间 | 1641744000000 |
| endTime | BigDecimal | 过期时间 | 1665331200000 |
| couponStatus | String | 状态 | NORMAL |
| status | String | 筛选状态 | USED_UP |
| region | String | 适用地域 | global |
| conditionArgsMap | ConditionArgsMap | 特殊场景参数 | |
| effectArgsMap | EffectArgsMap | 效果参数 | |
| conditionEffectDescription | String | 特殊场景描述 | 通用 |
请求示例
POST /api/bes/cluster/coupon/avail
<公共请求头>
x-Region: bd
{ }响应示例
HTTP/1.1 200 OK
<公共响应头>
{
"result" : {
"coupons" : [ {
"productRuleDescription" : "通用（除域名/短信/专线/商标知产/证书/工商财税）",
"effectArgsMap" : { },
"amountOrDiscount" : "500.00",
"usedAmount" : "usedAmount",
"productTypes" : "[\"COMMON\"]",
"conditionEffectDescription" : "通用",
"totalAmount" : 500.00,
"balance" : "500.00",
"conditionArgsMap" : { },
"couponType" : "CASH_COUPON",
"name" : "DN1EIM18VLLYBN8",
"couponStatus" : "NORMAL",
"id" : 1189112,
"beginTime" : 1641744000000,
"endTime" : 1665331200000,
"region" : "global",
"productType" : "COMMON",
"status" : "USED_UP"
}, {
"productRuleDescription" : "通用（除域名/短信/专线/商标知产/证书/工商财税）",
"effectArgsMap" : { },
"amountOrDiscount" : "500.00",
"usedAmount" : "usedAmount",
"productTypes" : "[\"COMMON\"]",
"conditionEffectDescription" : "通用",
"totalAmount" : 500.00,
"balance" : "500.00",
"conditionArgsMap" : { },
"couponType" : "CASH_COUPON",
"name" : "DN1EIM18VLLYBN8",
"couponStatus" : "NORMAL",
"id" : 1189112,
"beginTime" : 1641744000000,
"endTime" : 1665331200000,
"region" : "global",
"productType" : "COMMON",
"status" : "USED_UP"
} ]
},
"success" : true,
"status" : 200
}错误码
请参考通用错误码