会员api说明
接口地址 | http://host:port/pospal-api2/openapi/v1/customeropenapi/querybynumber | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
customernum | 是 | string | 会员号 |
groupshare | 否 | int | 分组共享:只有后台连锁会员共享设置是分组共享时,该字段才有意义。传1 表示,严格按照分组共享逻辑查询。比如a,b 2家店是一组,c,d是一组,groupshare=1时,a店能查到b店的,但查不到c店的会员 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
customeruid | long | 会员在银豹系统的唯一标识 | |
categoryname | string | 会员所属分类名称 | |
number | string | 会员号 | |
name | string | 会员姓名 | |
point | bigdecimal | 会员当前积分 | |
discount | bigdecimal | 会员享受的折扣,60%以60表示 | |
balance | bigdecimal | 会员当前通用余额 | |
phone | string | 会员联系电话 | |
birthday | string | 会员生日 | |
string | qq号 | ||
string | 会员邮箱 | ||
address | string | 会员住址 | |
remarks | string | 备注信息 | |
createddate | string | 创建会员的日期 | |
onaccount | int | 是否允许赊账,1表示允许 | |
enable | int | -1:删除;0:禁用;1:可用; | |
password | string | 调用encrypttomd5string(string content)处理 | |
expirydate | string | 到期日期 | |
createstoreappidoraccount | string | 开卡门店 | |
weixinopenids | list | 微信openid相关信息 | |
openid | string | openid | |
openidtype | int | 0公众号 1小程序 1000微信unionid | |
extinfo | json | 扩展信息 | |
sex | int | 性别:1-男,0-女,null未填写 | |
lunarbirthday | string | 阴历生日 | |
totalpoint | bigdecimal | 累计积分 | |
creditlimit | bigdecimal | 赊账额度 | |
creditperiod | bigdecimal | 赊账账期,单位天 | |
amountinarrear | int | 欠款金额 | |
photopath | string | 会员照片路径 返回的不带域名,请自行加上域名:https://imgw.pospal.cn | |
nickname | string | 会员昵称 |
接口地址 | http://host:port/pospal-api2/openapi/v1/customeropenapi/querybyuid | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
customeruid | 是 | long | 会员在银豹系统的唯一标识 |
groupshare | 否 | int | 分组共享:只有后台连锁会员共享设置是分组共享时,该字段才有意义。传1 表示,严格按照分组共享逻辑查询。比如a,b 2家店是一组,c,d是一组,groupshare=1时,a店能查到b店的,但查不到c店的会员 |
返回结果 |
| ||
字段名 | 类型 | 说明 | |
|
接口地址 | http://host:port/pospal-api2/openapi/v1/customeropenapi/querycustomerpages | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
startcreatedatetime | 否 | string | 创建时间,格式为yyyy-mm-dd hh:mm:ss,包含开始时间 |
groupshare | 否 | int | 分组共享:只有后台连锁会员共享设置是分组共享时,该字段才有意义。传1 表示,严格按照分组共享逻辑查询。比如a,b 2家店是一组,c,d是一组,groupshare=1时,a店能查到b店的,但查不到c店的会员 |
postbackparameter | 否 | json | 查询凯发官方首页时可以不传,之后的内容从返回结果中取出 |
parametertype | 是 | string | 从返回结果中取出 |
parametervalue | 是 | string | 从返回结果中取出 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
pagesize | int | 本次查询预期从数据库中取出记录数,如果结果集的长度小于pagesize,不需要进行下一页查询 | |
postbackparameter | json | 分页查询回传到服务器的参数结构从第二页开始必须回传,如果没传,每次查询都是第一页 | |
parametertype | string | 从返回结果中直接取出用于回传,不能变其值 | |
parametervalue | string | 从返回结果中直接取出用于回传,不能变其值 | |
result | list |
会员字段参照 1.根据会员号查询会员 |
接口地址 | http://host:port/pospal-api2/openapi/v1/customeropenapi/updatebaseinfo | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
customeruid | 是 | long | 会员在银豹系统的唯一标识 |
name | 否 | string | 会员姓名,传空或不传不做修改操作 |
phone | 否 | string | 会员联系电话,传空或不传不做修改操作 |
birthday | 否 | string | 会员生日,传空或不传不做修改操作 |
否 | string | qq号,传空或不传不做修改操作 | |
否 | string | 会员邮箱,传空或不传不做修改操作 | |
address | 否 | string | 会员住址,传空或不传不做修改操作 |
remarks | 否 | string | 备注信息,传空或不传不做修改操作 |
enable | 否 | integer | 会员状态,1可用、0禁用、-1删除,不传不做修改操作 |
categoryname | 否 | string | 会员分类名称 |
discount | 否 | bigdecimal | 会员折扣,如果会员价打9折,传90 会员价=折扣前价格 * discount / 100 |
onaccount | 否 | integer | 是否可赊账:1可赊账,0不可赊账 |
expirydate | 否 | string | 到期日期 格式:yyyy-mm-dd hh:mm:ss |
extinfo | 否 | json | 扩展信息 |
sex | 否 | int | 性别:1-男,0-女,null未填写 |
lunarbirthday | 否 | string | 阴历生日 |
totalpoint | 否 | bigdecimal | 累计积分 |
creditlimit | 否 | bigdecimal | 赊账额度 |
creditperiod | 否 | bigdecimal | 赊账账期,单位天 |
amountinarrear | 否 | int | 欠款金额 |
nickname | 否 | string | 会员昵称 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 |
接口地址 | http://host:port/pospal-api2/openapi/v1/customeropenapi/updatebalancepointbyincrement | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
customeruid | 是 | long | 会员在银豹系统的唯一标识 |
balanceincrement | 是 | bigdecimal | 金额增长量,修改结果为银豹系统中的会员余额 balanceincrement 传负数,表示扣减 |
pointincrement | 是 | bigdecimal | 积分增长量, 修改结果为银豹系统中的会员积分 pointincrement 传负数,表示扣减 |
datachangetime | 是 | string | 在调用方的金额变动时间,格式为yyyy-mm-dd hh:mm:ss,不可为空。 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
customeruid | long | 会员在银豹系统的唯一标识 | |
balancebeforeupdate | bigdecimal | 修改前会员余额 | |
balanceafterupdate | bigdecimal | 修改后会员余额 | |
balanceincrement | bigdecimal | 余额变动量 | |
pointbeforeupdate | bigdecimal | 修改前会员积分 | |
pointafterupdate | bigdecimal | 修改后会员积分 | |
pointincrement | bigdecimal | 会员积分变动量 | |
datachangetime | string | 数据在调用方的变动时间 | |
updatecustomertime | string | 更新到银系统时间的时间 |
接口地址 | http://host:port/pospal-api2/openapi/v1/customeropenapi/add | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
categoryname | 否 | string | 会员所属分类名称 |
number | 是 | string | 会员号 |
name | 是 | string | 会员姓名,不知道姓名,可填会员号或联系电话 |
phone | 是 | string | 会员联系电话 |
birthday | 否 | string | 会员生日, 默认为空 |
否 | string | qq号, 默认为空 | |
否 | string | 会员邮箱,默认为空 | |
address | 否 | string | 会员住址,认为空 |
remarks | 否 | string | 备注信息,默认为空 |
point | 否 | bigdecimal | 会员积分,默认为0 |
discount | 否 | bigdecimal | 会员折扣,0-100,默认为100(不打折) |
balance | 否 | bigdecimal | 会员余额,默认为0 |
enable | 否 | int | -1:删除;0:禁用;1:可用; |
onaccount | 否 | int | 是否允许会员赊账,0或1,默认为1 |
expirydate | 否 | string | 到期日期 格式:yyyy-mm-dd hh:mm:ss |
password | 否 | string | 会员密码(明文),长度为1~16位 |
extinfo | 否 | json | 扩展信息 |
sex | 否 | int | 性别:1-男,0-女,null未填写 |
lunarbirthday | 否 | string | 阴历生日 |
totalpoint | 否 | bigdecimal | 累计积分 |
creditlimit | 否 | bigdecimal | 赊账额度 |
creditperiod | 否 | bigdecimal | 赊账账期,单位天 |
amountinarrear | 否 | int | 欠款金额 |
nickname | 否 | string | 会员昵称 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | json | 会员字段参照1.根据会员号查询会员 |
接口地址 | http://host:port/pospal-api2/openapi/v1/customeropenapi/queryallrechargelogs | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
statedate | 是 | string | 开始时间,格式为yyyy-mm-dd hh:mm:ss,不包含开始时间 |
enddate | 是 | string | 结束时间,格式为yyyy-mm-dd hh:mm:ss,包含结束时间enddate – startdate <=31天 |
appid | 是 | string | pospal配置的访问凭证,任何门店的appid都可以查出所有用用过的核销码 |
postbackparameter | 否 | json | pospal查询凯发官方首页时可以不传,之后的内容从返回结果中取出 |
parametertype | 是 | string | 从返回结果中取出 |
parametervalue | 是 | string | 从返回结果中取出 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
pagesize | int | 本次查询预期从库存取出记录数,如果结果集的长度小于pagesize,不需要进行下一页查询 | |
postbackparameter | json | pospal查询凯发官方首页时可以不传,之后的内容从返回结果中取出 | |
parametertype | string | 从返回结果中取出 | |
parametervalue | string | 从返回结果中取出 | |
result | list | 单据实体信息,字段信息参照会员通用金额充值日志查询 |
接口地址 | http://host:port/pospal-api2/openapi/v1/customeropenapi/querycustomerrechargelog | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
customeruid | 是 | long | 会员在银豹收银系统的唯一标识 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | list | 充值日志实体 | |
rechargestoreappid | string | 充值门店的appid | |
rechargestoreaccount | string | 充值门店的账号 | |
customeruid | long | 会员在银豹系统唯一标识,与请求参数customeruid相同 | |
rechargemoney | double | 充值金额 | |
giftmoney | double | 充值时赠送的金额,(充值购物卡等其它充值方式时,也有可能赠送通用金额,这时也会有一条这样的记录)云端后台可以设置充值规则 | |
datetime | string | 充值时间 | |
paymethod | string | 充值时会员所使用的凯发官方首页的支付方式 | |
customermoneyafterrecharge | string | 充值后,会员剩余金额 |
接口地址 | http://host:port/pospal-api2/openapi/v1/customeropenapi/querybytel | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
customertel | 是 | string | 会员手机号 |
groupshare | 否 | int | 分组共享:只有后台连锁会员共享设置是分组共享时,该字段才有意义。传1 表示,严格按照分组共享逻辑查询。比如a,b 2家店是一组,c,d是一组,groupshare=1时,a店能查到b店的,但查不到c店的会员 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | list | 参照1. 根据会员号查询会员返回结果的字段说明 |
接口地址 | http://host:port/pospal-api2/openapi/v1/customeropenapi/queryallcustomercategory | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | list | 会员分类实体 | |
name | string | 会员分类名称 | |
discount | bigdecimal | 会员分类折扣,discount=90,表示打9折,会员价=折扣前价格 * discount / 100 | |
uid | long | 分类实体唯一标识 | |
enable | int | 该分类是否可用 | |
ispoint | int | 该分类会员是否可积分 |
接口地址 | http://host:port/pospal-api2/openapi/v1/customeropenapi/batchupdatecategory | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
customercategories | 是 | [] | 数组 限制最多100条记录 |
customeruid | 是 | long | 会员唯一标识,根据会员唯一标识修改会员类型 customernumber不为空,customeruid不传;customernumber为空,customeruid必填 |
customernumber | 是 | string | 会员号,根据会员号修改会员类型 customeruid不为空,customernumber不传;customeruid为空,customernumber必填 |
customercategoryuid | 是 | long | 会员类型唯一标识 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 |
接口地址 | http://host:port/pospal-api2/openapi/v1/customeropenapi/updatecustomerpassword | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
customeruid | 是 | long | 会员唯一标识 |
customerpassword | 是 | string | 会员密码(明文),长度为1~16位 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 |