会员API说明
更新时间:2018-08-01
1. 根据会员号查询会员
2. 根据会员在银豹系统的唯一标识查询
3. 分页查询全部会员
4. 修改会员基本信息
5. 修改会员余额积分
6. 添加会员
7. 查询全部通用金额充值记录
8.会员通用金额充值日志查询
9. 根据手机号查询会员信息
10. 查询所有会员分类(会员等级)
11. 批量修改会员类型(等级)
12. 修改会员密码
1. 根据会员号查询会员

接口地址http://host:port/pospal-api2/openapi/v1/customerOpenApi/queryByNumber
请求头User-Agent: openApiContent-Type: application/json; charset=utf-8accept-encoding: gzip,deflatetime-stamp: 1437528688233data-signature: BF706E6AC693BA3B1BABD32E6713431D
请求方式POST
请求体{"appId": "abcdefghijklmn","customerNum": "8008010001"}
参数名是否必须类型说明
appId是StringPospal配置的访问凭证
customerNum是String会员号
返回结果{"status": "success","messages": [],"errorCode":null"data": {"customerUid": 813951242628553689,"categoryName": "金卡","number": "银豹收银","name": "OpenApi创建","point": 0,"discount": 60,"balance": 0,"phone": "17759205640","qq": "673874555","email": "test@gmail.com","address": "厦门思明区吕领路必利达大厦","remarks": "备注信息","onAccount": 0,"enable": 1,"password": "abcdefg","createStoreAppIdOrAccount": "mylin0"}}
字段名类型说明
statusString是否正确处理请求,返回success或error,不区分大小写
messagesString[]处理结果的消息
customerUidlong会员在银豹系统的唯一标识
categoryNameString会员所属分类名称
numberString会员号
nameString会员姓名
pointBigDecimal会员当前积分
discountBigDecimal会员享受的折扣,60%以60表示
balanceBigDecimal会员当前通用余额
phoneString会员联系电话
birthdayString会员生日
qqStringQQ号
emailString会员邮箱
addressString会员住址
remarksString备注信息
createdDateString创建会员的日期
onAccountint是否允许赊账,1表示允许
enableint-1:删除;0:禁用;1:可用;
passwordString调用encryptToMd5String(String content)处理
expiryDateString过期时间
createStoreAppIdOrAccountString开卡门店

2. 根据会员在银豹系统的唯一标识查询

接口地址http://host:port/pospal-api2/openapi/v1/customerOpenApi/queryByUid
请求头User-Agent: openApiContent-Type: application/json; charset=utf-8accept-encoding: gzip,deflatetime-stamp: 1437528688233data-signature: BF706E6AC693BA3B1BABD32E6713431D
请求方式POST
请求体{"appId": "abcdefghijklmn","customerUid": 8008010001}
参数名是否必须类型说明
appId是StringPospal配置的访问凭证
customerUid是Long会员在银豹系统的唯一标识
返回结果

3. 分页查询全部会员

接口地址http://host:port/pospal-api2/openapi/v1/customerOpenApi/queryCustomerPages
请求头User-Agent: openApiContent-Type: application/json; charset=utf-8accept-encoding: gzip,deflatetime-stamp: 1437528688233data-signature: BF706E6AC693BA3B1BABD32E6713431D
请求方式POST
请求体{"appId": "abcdefghijklmn","postBackParameter": {"parameterType": "abcd",从返回结果中直接取出"parameterValue": "abcd"}}
参数名是否必须类型说明
appId是StringPospal配置的访问凭证
startCreateDateTime否String创建时间,格式为yyyy-MM-dd HH:mm:ss,包含开始时间
postBackParameter否Json查询首页时可以不传,之后的内容从返回结果中取出
parameterType是String从返回结果中取出
parameterValue是String从返回结果中取出
返回结果{"status": "success","messages": [],"data": {"postBackParameter": {"parameterType": "abcd",从返回结果中直接取出"parameterValue": "abcd"},"pageSize": 100,"result": [{"customerUid": 612470307777855407,"categoryName": "","number": "yelb007","name": "yyyy","point": 0,"discount": 100,"balance": 0,"phone": "13600927865","qq": "","email": "","address": "","password": "ABEDDDWSSWWW","onAccount": 0,"enable": 1}]}}
字段名类型说明
statusString是否正确处理请求,返回success或error,不区分大小写
messagesString[]处理结果的消息
pageSizeint本次查询预期从数据库中取出记录数,如果结果集的长度小于pageSize,不需要进行下一页查询
postBackParameterjson分页查询回传到服务器的参数结构从第二页开始必须回传,如果没传,每次查询都是第一页
parameterTypeString从返回结果中直接取出用于回传,不能变其值
parameterValueString从返回结果中直接取出用于回传,不能变其值
resultList会员字段参照 1.根据会员号查询会员

4. 修改会员基本信息

接口地址http://host:port/pospal-api2/openapi/v1/customerOpenApi/updateBaseInfo
请求头User-Agent: openApiContent-Type: application/json; charset=utf-8accept-encoding: gzip,deflatetime-stamp: 1437528688233data-signature: BF706E6AC693BA3B1BABD32E6713431D
请求方式POST
请求体{"appId": "abcdefghijklmn","customerInfo": {"customerUid": 360135572336007987,"name": "银豹收银","phone": "17759205640","birthday": "","qq": "","email": "","address": "","categoryName": "金卡","discount": 60,"onAccount": 0,"remarks": "通过银豹收银OpenApi修改,“enable”:1,"extInfo": {"sex": 1,"totalPoint": 15,"creditLimit": 5000,"creditPeriod": 10,"amountInArrear": 1000,"photoPath": "https://testdomain/test.jpg","nickName": "小灰灰"}}}
参数名是否必须类型说明
appId是StringPospal配置的访问凭证
customerUid是Long会员在银豹系统的唯一标识
name否String会员姓名,传空或不传不做修改操作
phone否String会员联系电话,传空或不传不做修改操作
birthday否String会员生日,传空或不传不做修改操作
qq否StringQQ号,传空或不传不做修改操作
email否String会员邮箱,传空或不传不做修改操作
address否String会员住址,传空或不传不做修改操作
remarks否String备注信息,传空或不传不做修改操作
enable否Integer会员状态,1可用、0禁用、-1删除,不传不做修改操作
categoryName否String会员分类名称
discount否BigDecimal会员折扣,如果会员价打9折,传90
会员价=折扣前价格 * discount / 100
onAccount否Integer是否可赊账:1可赊账,0不可赊账
extInfo否Json扩展信息
sex否Int性别:1-男,0-女,NULL未填写
lunarBirthday否String阴历生日
totalPoint否BigDecimal累计积分
creditLimit否BigDecimal赊账额度
creditPeriod否BigDecimal赊账账期,单位天
amountInArrear否int欠款金额
photoPath否String会员照片路径photoPath.length