开发平台

电话咨询 400-000-7749

QQ咨询

1. 根据会员号查询会员


接口地址 http://host:port/pospal-api2/openapi/v1/customerOpenApi/queryByNumber
请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "customerNum": "8008010001"
  • }
  • 参数名 是否必须 类型 说明
    appId String Pospal配置的访问凭证
    customerNum String 会员号
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "errorCode":null
  • "data": {
  • "customerUid": 813951242628553689,
  • "categoryName": "金卡",
  • "number": "银豹收银",
  • "name": "OpenApi创建",
  • "point": 0,
  • "discount": 60,
  • "balance": 0,
  • "phone": "17759205640",
  • "birthday": "2015-09-15 00:00:00",
  • "qq": "673874555",
  • "email": "test@gmail.com",
  • "address": "厦门思明区吕领路必利达大厦",
  • "remarks": "备注信息",
  • "createdDate": "2015-09-15 00:00:00",
  • "onAccount": 0,
  • "enable": 1,
  • "password": "abcdefg",
  • "expiryDate": "2015-09-15 00:00:00"
  • "createStoreAppIdOrAccount": "mylin0"
  • }
  • }
  • 字段名 类型 说明
    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 会员生日
    qq String QQ号
    email String 会员邮箱
    address String 会员住址
    remarks String 备注信息
    createdDate String 创建会员的日期
    onAccount int 是否允许赊账,1表示允许
    enable int -1:删除;0:禁用;1:可用;
    password String 调用encryptToMd5String(String content)处理
    expiryDate String 过期时间
    createStoreAppIdOrAccount String 开卡门店

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


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

  • 3. 分页查询全部会员


    接口地址 http://host:port/pospal-api2/openapi/v1/customerOpenApi/queryCustomerPages
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "postBackParameter": {
  • "parameterType": "abcd",从返回结果中直接取出
  • "parameterValue": "abcd"
  • }
  • }
  • 参数名 是否必须 类型 说明
    appId String Pospal配置的访问凭证
    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",
  • "birthday": "2015-10-16",
  • "qq": "",
  • "email": "",
  • "address": "",
  • "createdDate": "2015-10-16 00:00:00",
  • "password": "ABEDDDWSSWWW",
  • "onAccount": 0,
  • "enable": 1
  • }
  • ]
  • }
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    pageSize int 本次查询预期从数据库中取出记录数,如果结果集的长度小于pageSize,不需要进行下一页查询
    postBackParameter json 分页查询回传到服务器的参数结构从第二页开始必须回传,如果没传,每次查询都是第一页
    parameterType String 从返回结果中直接取出用于回传,不能变其值
    parameterValue String 从返回结果中直接取出用于回传,不能变其值
    result List 会员字段参照2.1

    4. 修改会员基本信息


    接口地址 http://host:port/pospal-api2/openapi/v1/customerOpenApi/updateBaseInfo
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "customerInfo": {
  • "customerUid": 360135572336007987,
  • "name": "银豹收银",
  • "phone": "17759205640",
  • "birthday": "",
  • "qq": "",
  • "email": "",
  • "address": "",
  • "remarks": "通过银豹收银OpenApi修改
  • }
  • }
  • 参数名 是否必须 类型 说明
    appId String Pospal配置的访问凭证
    customerUid Long 会员在银豹系统的唯一标识
    name String 会员姓名,传空或不传不做修改操作
    phone String 会员联系电话,传空或不传不做修改操作
    birthday String 会员生日,传空或不传不做修改操作
    qq String QQ号,传空或不传不做修改操作
    email String 会员邮箱,传空或不传不做修改操作
    address String 会员住址,传空或不传不做修改操作
    remarks String 备注信息,传空或不传不做修改操作
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "errorCode":null
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表

    5. 修改会员余额积分


    接口地址 http://host:port/pospal-api2/openapi/v1/customerOpenApi/updateBalancePointByIncrement
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "customerUid":231607639459718452,
  • "balanceIncrement":100,
  • "pointIncrement": 100,
  • "dataChangeTime": "2015-12-16 13:26:23"
  • }
  • 参数名 是否必须 类型 说明
    appId String Pospal配置的访问凭证
    customerUid Long 会员在银豹系统的唯一标识
    balanceIncrement BigDecimal 金额增长量,修改结果为银豹系统中的会员余额+balanceIncrement
    pointIncrement BigDecimal 积分增长量, 修改结果为银豹系统中的会员积分+ pointIncrement
    dataChangeTime String 在调用方的金额变动时间,格式为yyyy-MM-dd hh:mm:ss,不可为空。
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "errorCode":null,//如果"status": "success",这个字段没有值
  • "data": {
  • "customerUid": 231607639459718460,
  • "balanceBeforeUpdate": 400,
  • "balanceAfterUpdate": 500,
  • "balanceIncrement": 100,
  • "pointBeforeUpdate": 300,
  • "pointAfterUpdate": 400,
  • "pointIncrement": 100,
  • "dataChangeTime": "2015-12-16 15:26:43",
  • "updateCustomerTime": "2015-12-16 14:37:30"
  • }
  • }
  • 字段名 类型 说明
    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 更新到银系统时间的时间

    6. 添加会员


    接口地址 http://host:port/pospal-api2/openapi/v1/customerOpenApi/add
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "customerInfo": {
  • "categoryName": "金卡",
  • "number": "Pospal002”,
  • "name": "OpenApi创建",
  • "point": 0,
  • "discount": 60,
  • "balance": 0,
  • "phone": "17759205640",
  • "birthday": "",
  • "qq": "",
  • "email": "",
  • "address": "",
  • "remarks": "",
  • "onAccount": 0,
  • "enable": 1
  • "password": "EA4CEADDDDDD"
  • }
  • }
  • 参数名 是否必须 类型 说明
    appId String Pospal配置的访问凭证
    categoryName String 会员所属分类名称
    number String 会员号
    name String 会员姓名,默认为空
    phone String 会员联系电话,默认为空
    birthday String 会员生日, 默认为空
    qq String QQ号, 默认为空
    email String 会员邮箱,默认为空
    address String 会员住址,认为空
    remarks String 备注信息,默认为空
    point BigDecimal 会员积分,默认为0
    discount BigDecimal 会员折扣,0-100,默认为0
    balance BigDecimal 会员余额,默认为0
    enable Int -1:删除;0:禁用;1:可用;
    onAccount Int 是否允许会员赊账,0或1,默认为1
    password String 会员密码
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "errorCode":null
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表

    7. 查询全部通用金额充值记录


    接口地址 http://host:port/pospal-api2/openapi/v1/customerOpenApi/queryAllRechargeLogs
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "stateDate": "2017-05-01 00:00:00",//开始时间(结束时间(不包含))
  • "endDate": "2017-05-05 23:59:59",//结束时间(包含)
  • "postBackParameter": {
  • "parameterType": "abcdef",//从返回结果中直接取出
  • "parameterValue": "abcdef",//从返回结果中直接取出
  • },
  • "appId": "abcdefghijklmn"
  • }
  • 参数名 是否必须 类型 说明
    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": "success",
  • "data": {
  • "postBackParameter":{
  • "parameterType":"abcdefghijk",
  • "parameterValue":"abcdefghijk",
  • },
  • "result":[
  • {
  • "rechargeStoreAccount":"mylind1"
  • "customerUid":363700050656122383
  • "rechargeMoney":200
  • "giftMoney":20
  • "datetime":"2016-10-31 11:40:15"
  • "uid":"1477885215213525326"
  • "payMethod":"银联卡"
  • "customerMoneyAfterRecharge":400
  • }
  • ],
  • "pageSize":100
  • }
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    pageSize int 本次查询预期从库存取出记录数,如果结果集的长度小于pageSize,不需要进行下一页查询
    postBackParameter Json Pospal查询首页时可以不传,之后的内容从返回结果中取出
    parameterType String 从返回结果中取出
    parameterValue String 从返回结果中取出
    result List 单据实体信息,字段信息参照会员通用金额充值日志查询

    8. 会员通用金额充值日志查询


    接口地址 http://host:port/pospal-api2/openapi/v1/customerOpenApi/queryCustomerRechargeLog
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "customerUid": 677793671220529313{
  • }
  • 参数名 是否必须 类型 说明
    appId String Pospal配置的访问凭证
    customerUid Long 会员在银豹收银系统的唯一标识
    返回结果
  • {
  • "status": "success",
  • "data": [
  • {
  • "rechargeStoreAppId":"87EB2C555BBF382E7F6C7B275B0C502A",
  • "rechargeStoreAccount":"adasun4",
  • "customerUid":"677793671220529313",
  • "rechargeMoney":"100",
  • "giftMoney":0,
  • "datetime":"2016-10-28 11:14:03",
  • "payMethod":"现金",
  • "customerMoneyAfterRecharge":100
  • },
  • {
  • "rechargeStoreAppId":"87EB2C555BBF382E7F6C7B275B0C502A",
  • "rechargeStoreAccount":"adasun4",
  • "customerUid":"677793671220529313",
  • "rechargeMoney":"100",
  • "giftMoney":0,
  • "datetime":"2016-10-28 11:14:03",
  • "payMethod":"现金",
  • "customerMoneyAfterRecharge":100
  • }
  • ]
  • }
  • 字段名 类型 说明
    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 充值后,会员剩余金额

    9. 根据会员手机号查询会员


    接口地址 http://host:port/pospal-api2/openapi/v1/customerOpenapi/queryBytel
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "customerTel": "17759205640"
  • }
  • 参数名 是否必须 类型 说明
    appId String Pospal配置的访问凭证
    customerTel String 会员手机号
    返回结果
  • 说明:如果多个会员的手机号相同,可能返回多条记录
  • {
  • "status": "success",
  • "messages": [],
  • "errorCode":null
  • "data": [
  • {
  • "customerUid
  • "categoryName": "金卡",
  • "number": "银豹收银",
  • "name": "OpenApi创建",
  • "point": 0,
  • "discount": 60,
  • "balance": 0,
  • "phone": "17759205640",
  • "birthday": "2015-09-15 00:00:00",
  • "qq": "673874555",
  • "email": "test@gmail.com",
  • "address": "厦门思明区吕领路必利达大厦",
  • "remarks": "备注信息",
  • "createdDate": "2015-09-15 00:00:00",
  • "onAccount": 0,
  • "enable": 1,
  • "password": "abcdefg",
  • "expiryDate": "2015-09-15 00:00:00"
  • "createStoreAppIdOrAccount": "mylin0"
  • }
  • ]
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    data list 参照1. 根据会员号查询会员返回结果的字段说明