依据收银员账号查询可发券列表信息。
method: allinpay.shopoint.couponService.couponCanSendListNew
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
userId |
String |
是 |
|
用户账号 |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
|
错误信息 |
|
||
|
data |
|
List |
|
|
可发券列表 |
|
|
|
orgId |
Integer |
是 |
|
机构ID |
|
||
|
activityId |
Integer |
是 |
|
发券活动ID |
|
||
|
activityName |
String |
是 |
|
发券活动名称 |
|
||
|
beginTime |
String |
是 |
|
发放开始时间 |
|
||
|
endTime |
String |
是 |
|
发放结束时间 |
|
||
|
maxNum |
Integer |
是 |
|
库存 |
0表示不限制 |
||
|
sentCount |
Integer |
是 |
|
已发数量 |
|
||
|
receivedCount |
Integer |
是 |
|
已领数量 |
|
||
|
status |
Integer |
是 |
|
是否启用 |
0-停用 1-启用 |
||
|
couponTemplateItemList |
List |
是 |
|
券模板列表 |
|
||
|
|
templateId |
Integer |
是 |
|
模板ID |
|
|
|
|
couponName |
String |
是 |
|
券名称 |
|
|
|
|
couponType |
int |
是 |
|
券类型 |
0-现金卡 1-代金券 2-计次券 3-满减活动券 |
|
|
|
sendNum |
Integer |
是 |
|
该券模版发几张 |
|
|
|
|
initAmount |
Integer |
是 |
|
余额 |
初始金额、次数, 单位：分 |
|
|
|
unit |
String |
否 |
|
单位 |
计次券时返回 |
|
|
|
validityType |
Integer |
是 |
|
有效期类型 |
0 - 指定日期范围 1 - 领用之日起n天内 |
|
|
|
validityBeginDate |
String |
否 |
|
有效期起始日期 |
null表示不限制 validityType=0返回 |
|
|
|
validityEndDate |
String |
否 |
|
有效期结束日期 |
||
|
|
validityDays |
Integer |
否 |
|
领用之日起多少天内有效 |
validityType=1返回 |
|
|
|
validityBeginDays |
Integer |
否 |
|
领用后多少天后生效 |
||
|
|
rangeDate |
Integer |
否 |
|
可用日期,NULL表示不限制，否则解析字符串获取。具体解析方法请参考SDK工具包中的DateUtils.getDatesInt方法。 |
|
|
|
|
rangeDayOfWeek |
Integer |
否 |
|
每周几可用。具体解析方法请参考SDK工具包中的DateUtils.getWeeksInt方法。 |
|
|
|
|
rangeTime |
|
|
|
每天哪些时段可用,NULL表示不限制，否则解析字符串获取设定规则 示例： 9:30~10:30,17:00~19:00 |
|
|
|
|
usableAmount |
BigDecimal |
否 |
|
每满多少金额可以使用1张 |
couponType=3满减券时有效 |
|
|
|
usableMaxNum |
Integer |
否 |
|
每笔订单最多使用多少张 |
couponType=3满减券时有效 |
|
|
|
instruction |
String |
否 |
|
券使用须知 |
|
|
请求示例
{”userId”:”123”}
响应示例
{
"code": "0",
"data": [{
"activityId": 186,
"couponTemplateItemList": [{
"rangeDate": 2147483647,
"usableMaxNum": 2147483647,
"couponName": "发券测试0908",
"validityType": 1,
"couponType": 0,
"instruction": "123",
"validityBeginDays": 0,
"initAmount": 100,
"sendNum": 1,
"templateId": 1323,
"validityDays": 10
}],
"activityName": "pos接口发券测试",
"receivedCount": 1,
"beginTime": "2021-03-02 00:00:00",
"endTime": "2021-04-30 23:59:59",
"maxNum": 100,
"orgId": 100038,
"sentCount": 2,
"status": 1
}],
"sign":"fQ0OPoOVA6FJJZid6QfKm+0dXUQ6ZktdeP9PsQTtlliaco1omTKSxzmKwjvlds6qM3wLd4VzKCCB1Sk1YNL2sbTvNXRqFCwQee87 PrHqKcH6hQekge440ak2IvmrVfkUo9IVyMbCUOO46Ok8eEYLfEXJUilgbQho+J4SRxeVnQo="
}