3.1.1会员账户信息查询
根据会员手机号等信息查询会员余额、积分、优惠券等信息。
接口方法:
method: allinpay.shopoint.memberService.memberQuery
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
idType |
String |
是 |
|
会员账号类型 |
1- 手机号 2- 会员卡号 3- Openid 4- 会员动态码 5- 外部会员ID 6- 内部会员ID |
memberId |
String |
是 |
|
会员账号 |
|
shopId |
String |
否 |
|
店铺ID |
输入则couponList只返回该店铺下的可用优惠券 |
couponStatus |
Integer |
否 |
|
|
0 - 全部有效卡券 1 – 当前可用卡券 6 – 无效卡券 不填默认为1 |
shopCode |
String |
否 |
|
店铺号 |
与shopId功能相同,shopId和shopCode同时输入则只取shopId |
operUserId |
String |
否 |
|
收银员 |
输入则couponList只返回该收银员所在店铺的可用优惠券,如shopId和operUserId同时输入则,operUserId应属于shopId店铺 |
statusList |
List |
否 |
|
券状态,若有传入则忽略入参couponStatus |
0- 有效 1- 已冻结 2- 已作废 3- 已核销 5– 转赠中 9– 退款中 |
balanceGt |
Integer |
否 |
|
余额,单位(分) |
-1,0,正数 |
validityBeginDateLe |
String |
否 |
|
可用开始日期小于等于该日期 |
yyyy-MM-dd HH:mm:ss |
validityBeginDateGe |
String |
否 |
|
可用开始日期大于等于该日期 |
yyyy-MM-dd HH:mm:ss |
validityEndDateLe |
String |
否 |
|
可用结束日期小于等于该日期 |
yyyy-MM-dd HH:mm:ss |
validityEndDateGe |
String |
否 |
|
可用结束日期大于等于该日期 |
yyyy-MM-dd HH:mm:ss |
pageNo |
Integer |
否 |
|
券列表的页码 |
取值范围为1到1000, 非法值将会重设为默认值. 默认值1 |
pageSize |
Integer |
否 |
|
券列表的每页数量 |
取值范围为1到200, 非法值将会重设为默认值. 默认值200 |
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
code |
Integer |
是 |
|
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
||
msg |
String |
是 |
|
错误信息 |
|
||
data |
cardNo |
|
String |
是 |
|
实体会员卡号 |
|
orgId |
|
String |
是 |
|
机构号 |
|
|
balance |
|
String |
是 |
|
余额 |
单位:元 |
|
status |
|
Integer |
是 |
|
会员状态 |
0:正常 1:冻结 |
|
score |
|
String |
是 |
|
积分 |
|
|
couponTotal |
|
Integer |
是 |
|
券总数量 |
|
|
couponList |
|
|
是 |
|
可用券列表 |
|
|
couponList |
templateId |
Integer |
是 |
|
模板ID |
|
|
cardNo |
Integer |
否 |
|
卡号 |
|
||
couponNo |
String |
是 |
|
券号 |
|
||
couponName |
String |
是 |
|
券名称 |
|
||
couponType |
String |
是 |
|
券类型 |
0 现金卡 1 代金券 2 计次券 3 满减活动券 |
||
unit |
String |
否 |
|
券单位 |
计次券有效 |
||
balance |
BigDecimal |
是 |
|
余额 |
|
||
validityBeginDate |
String |
是 |
|
有效期起始日期 |
|
||
validityEndDate |
String |
是 |
|
有效期终止日期 |
|
||
hasPassword |
Boolean |
是 |
|
卡是否有密码
|
true:有密码 false:无密码 |
||
unusableReason |
String |
否 |
|
不可用券原因 |
|
||
status |
Integer |
是 |
|
券状态 |
态,0 - 有效 1 - 冻结 2 - 已作废 3 - 已核销 100 - 待生成 |
||
rangeTime |
String |
否 |
|
可用时间 |
不返回表示不限制,否则解析字符串获取设定规则 示例: 9:30~10:30,17:00~19:00 |
||
rangeDate |
Integer |
否 |
|
可用日期 |
不返回表示不限制,否则解析字符串获取设定。具体解析方法请参考SDK工具包中的DateUtils.getDatesInt方法。
|
||
rangeDayOfWeek |
Integer |
否 |
|
周几可用 |
不返回表示不限制,否则解析字符串获取设定。具体解析方法请参考SDK工具包中的DateUtils.getWeeksInt方法。 |
||
usableAmount |
BigDecimal |
否 |
|
每满多少金额可以使用1张 |
满减券使用 |
||
usableMaxNum |
Integer |
否 |
|
每笔订单最大优惠金额 |
满减券使用 |
||
instruction |
String |
否 |
|
券使用须知 |
|
||
|
|
|
|
|
|
请求示例
{"idType":"1","memberId":"13882177104"}
响应示例
{
"code": 0,
"data": {
"templateId": 794,
"couponNo": "10000000000001607134",
"couponName": "商品删除测试",
"couponType": 0,
"balance": 1,
"unit": null,
"rangeDate": 2102013412,
"rangeDayOfWeek": 42,
"rangeTime": “9:30~10:30,19:30~22:30”,
"validityType": null,
"validityBeginDate": [
2020,
4,
7,
0,
0
],
"validityEndDate": [
2020,
5,
7,
0,
0
]
},
"token": "QX1YbSPkNEbu5x1EDKzXDJtxy86sQnO6ExGe9nWs"
}