method: allinpay.shopoint.couponService.couponTemplateQuery
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
templateId |
Integer |
是 |
60 |
券模板id |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
|
msg |
String |
是 |
|
错误信息 |
|
|
|
data |
templateId |
Integer |
是 |
|
券模板id |
|
|
couponType |
Integer |
是 |
|
券类型 |
0-现金卡 2-计次券 3-满减活动券 |
|
|
couponName |
String |
是 |
|
券名称 |
|
|
|
initAmount |
Integer |
是 |
|
初始金额 |
单位: 分 |
|
|
unit |
String |
否 |
|
单位 |
计次券 |
|
|
validityType |
Integer |
是 |
|
有效期类型 |
0 - 指定日期范围 1 - 领用之日起n天内 |
|
|
|
validityBeginDate |
String |
否 |
|
有效期起始日期 |
validityType=0返回 |
|
validityEndDate |
String |
否 |
|
有效期结束日期 |
||
|
validityBeginDays |
Integer |
否 |
|
领用后多少天后生效 |
validityType=1返回 |
|
|
validityDays |
Integer |
否 |
|
领用之日起多少天内有效 |
||
|
rangeDate |
Integer |
否 |
|
可用日期 |
NULL表示不限制，否则解析字符串获取设定二级制位表示b0 - 1 号 b1 - 2号。具体解析方法请参考SDK工具包中的DateUtils.getDatesInt方法。 |
|
|
rangeDayOfWeek |
Integer |
否 |
|
每周几可用 |
通过对应的bit来确定是否允许，整个数字为255则表示不限 b0 - 周日 b1 - 周一 b2 - 周二 b3 - 周三 b4 - 周五 b5 - 周六。具体解析方法请参考SDK工具包中的DateUtils.getWeeksInt方法。 |
|
|
rangeTime |
String |
否 |
|
每天哪些时段可用 |
NULL表示不限制，否则解析字符串获取设定规则 示例： 9:30~10:30,17:00~19:00 |
|
|
usableAmount |
String |
否 |
|
每满多少金额可以使用1张 |
满减券使用 |
|
|
usableMaxNum |
Integer |
否 |
|
每笔订单最多使用多少张 |
满减券使用, 0表示不限制 |
|
|
instruction |
String |
否 |
|
券使用须知 |
|
|
请求示例
{"templateId ": 398"}
响应示例
{
"code": "0",
"data": {
"rangeDate": 2147483647,
"validityBeginDate": "2019-11-03 00:00:00",
"usableMaxNum": 2147483647,
"couponName": "500元现金卡",
"validityType": 0,
"couponType": 0,
"instruction": "11",
"validityBeginDays": 0,
"initAmount": 50000,
"templateId": 398,
"validityEndDate": "2019-11-30 23:59:59",
"validityDays": 0
},
"sign": "CTcDJQoQFqWT9VnDVY7my91O+JR4YlUviosnzg/zSRQ62 +f9XHk1tJIGC19dB1IFEGon3I6DzpC6iE8455Z5 +iJHI/FKknSmpCsoz2Gw+oj8V6gA9wv5YhLdYzuyG7o7fNpGfDqpye7UNavASRYSIM8ory92pJHb1Qk4d CvDSjw="
}