依据券号或券动态码该顾客同券模板下的券号列表详细信息
method: allinpay.shopoint.couponService.query
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
pageNo |
Integer |
否 |
|
页码 |
1-1000，默认1 |
|
pageSize |
Integer |
否 |
|
页大小 |
1-200，默认200 |
|
couponNo |
String |
是 |
|
券号或券动态码 |
|
|
queryMode |
String |
否 |
|
查询类型 |
single（默认）-查询输入的券号详细信息 |
|
status |
Integer |
否 |
|
券状态 |
与响应参数中和status相同 |
|
sortType |
Integer |
否 |
|
排序 |
-2代表金额倒序且创建时间倒序 |
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
|
msg |
String |
是 |
|
错误信息 |
|
|
|
data |
templateId |
Integer |
是 |
|
模板ID |
|
|
couponNo |
String |
是 |
|
券号 |
|
|
|
couponName |
String |
是 |
|
券名称 |
|
|
|
couponType |
Integer |
是 |
|
券类型 |
0-金额券 2-计次券 3-满减券 |
|
|
balance |
BigDecimal |
是 |
|
余额 |
|
|
|
initAmount |
BigDecimal |
是 |
|
面额 |
|
|
|
unit |
String |
是 |
|
单位 |
计次券使用 |
|
|
validityType |
Integer |
是 |
|
有效期类型 |
0 - 指定日期范围 1 - 领用之日起n天内 |
|
|
validityBeginDate |
String |
是 |
|
有效期起始日期 |
null表示不限制 |
|
|
validityEndDate |
String |
是 |
|
有效期结束日期 |
|
|
|
status |
Integer |
是 |
|
券状态 |
0-有效 1-冻结 2-已作废 3-已核销 4-已挂失 5-转赠中 6-失效 7-待兑换 8-已兑换 9-退款中 |
|
|
unusableReason |
String |
否 |
|
不可使用的原因 |
Status不为0是有描述 |
|
|
hasPassword |
Boolean |
是 |
|
是否有密码 |
True或false |
|
|
usableAmount |
BigDecimal |
否 |
|
每满多少金额可以使用1张 |
couponType=3满减券时有效 |
|
|
usableMaxNum |
Integer |
否 |
|
每笔订单最多使用多少张 |
couponType=3满减券时有效 |
|
|
instruction |
String |
否 |
|
券使用须知 |
|
|
请求示例
{
"pageNo": "1",
"pageSize": "10",
"couponNo": "100152202011230002",
"queryMode":"single"
}
响应示例
{
"code":"0",
"data":{
"coupons":[
{
"couponName":"导购外部计次",
"couponNo":"100152202011230002",
"hasPassword":false,
"templateId":1504,
"validityEndDate":"2020-12-12 23:59:59",
"unusableReason":"",
"validityBeginDate":"2020-11-23 00:00:00",
"unit":"次",
"validityType":1,
"balance":6.00,
"couponType":2,
"instruction":"不限制",
"initAmount":6.00,
"status":0
}
],
"pageNo":10,
"pageSize":1
}
}