OPENAPI V3
登录控制台
首次登录赠送 10000 Token,可直接调试接口
充值、回调配置、调用日志、接口调试均在控制台完成

会员接口文档

本页专门展示会员接口,便于单独交付与维护;通用规则仍复用总览页内容。Long 型标识字段、分页游标等通用约定,请先参考总览页《对接说明》。

会员接口

按业务对象聚合展示会员相关接口。会员分类 跟 会员等级 在银豹是一个意思,只是不同行业的叫法不同而已

会员归属于整个连锁,连锁下面会员uid,会员number,必须唯一

对接建议:account可以统一传总部门店账号

查询会员等级

POST
/openapi/v3/customer/category/list

查询当前会员归属账号下的会员等级。连锁场景下,会员等级使用总部 userId 查询,规则与 customer.userId 一致。

Token 消耗 固定 100 token/次

请求参数

参数类型必填说明
accountstring目标门店账号。用于鉴权后解析会员归属账号。
enableint等级状态。不传默认查询 enable != -1;传 1 只查启用,传 0 只查停用。

请求示例

{
  "account": "store001",
  "enable": 1
}

返回示例

{
  "status": "success",
  "errorCode": 0,
  "result": [
    {
      "uid": "10000",
      "name": "普通会员",
      "discount": "100",
      "enable": 1,
      "isPoint": 1,
      "sortValue": 1
    }
  ]
}

批量修改会员等级

POST
/openapi/v3/customer/category/batch-update

按会员 UID 或会员编号批量修改会员等级;单次最多 100 条,支持逐条返回处理结果。

Token 消耗max(100, 会员条数 × 10) 计算,最低 100 token/次;单次最多 1000 token

请求参数

参数类型必填说明
accountstring目标门店或总部账号。
itemsarray<object>会员明细,单次 1~100 条。
items[].customerUidlong二选一会员 UID;与 customerNumber 不能同时传。
items[].customerNumberstring二选一会员编号;与 customerUid 不能同时传。
items[].customerCategoryUidlong目标等级 UID;传 0 表示清除等级。
items[].discountdecimal会员专属折扣,不传则保留原值。

业务说明

  • items 是 v3 标准字段,同时兼容旧版字段名 customerCategories
  • 同一请求内不允许重复提交同一会员。
  • 目标等级必须属于会员归属账号且未删除;0 表示无等级。
  • 会员不存在或无权限时,该条返回失败,其他有效明细继续处理。
  • 相同 X-Request-Id 重试不会重复执行;失败请求请更换请求号后重试。

请求示例

{
  "account": "store001",
  "items": [
    {
      "customerUid": 3002001001,
      "customerCategoryUid": 6001
    },
    {
      "customerNumber": "VIP0002",
      "customerCategoryUid": 6002,
      "discount": 95
    }
  ]
}

返回示例

{
  "status": "success",
  "errorCode": 0,
  "result": {
    "successCount": 1,
    "failCount": 1,
    "results": [
      {
        "customerUid": "3002001001",
        "customerNumber": "VIP0001",
        "success": true,
        "message": "success",
        "oldCustomerCategoryUid": "5001",
        "customerCategoryUid": "6001",
        "oldDiscount": "100",
        "discount": "95"
      },
      {
        "customerNumber": "VIP0002",
        "success": false,
        "message": "会员不存在或无权修改"
      }
    ]
  }
}

查询会员标签

POST
/openapi/v3/customer/tag/list

查询当前会员归属账号下的会员标签字典,返回标签 UID、名称及所属标签分组信息;新增或修改会员时使用返回的 tagUid 填入 customerTagUids

Token 消耗 固定 100 token/次

请求参数

参数类型必填说明
accountstring目标门店账号,用于解析会员归属账号。

请求示例

{
  "account": "store001"
}

返回字段

字段类型说明
tagUidlong会员标签 UID;新增或修改会员时传入 customerTagUids
tagNamestring会员标签名称。
groupUidlong会员标签分组 UID;默认分组时为 0
groupNamestring会员标签分组名称;标签未关联分组时可能为空。
groupTypeint分组选择类型:0null 表示可多选,1 表示单选。
isRequiredint分组是否必选:0null 表示非必选,1 表示必选。

返回结果按标签分组 UID、标签排序值 orderIndex 和标签 ID 顺序排列。

返回示例

{
  "status": "success",
  "errorCode": 0,
  "result": [
    {
      "tagUid": "7001",
      "tagName": "高净值",
      "groupUid": "7000",
      "groupName": "客户分层",
      "groupType": 0,
      "isRequired": 0
    }
  ]
}

添加会员

POST
/openapi/v3/customer/add

新增会员基础资料,可选写入会员扩展表的性别、昵称、阴历生日。

Token 消耗 固定 200 token/次

请求参数

参数类型必填说明
accountstring开卡门店。
numberstring会员编号,长度不超过 32;同一连锁下唯一。
telstring手机号,长度不超过 32。
customerCategoryUidlong会员等级 UID。不传或传 0 时落库 0;传大于 0 的值时校验总部会员等级存在且未删除。
validateTelUniqueboolean是否校验手机号唯一。true 时同一 customer.userId 下不可存在相同手机号且 enable != -1 的会员;默认 false
namestring会员姓名,长度不超过 128;不传默认使用 tel
pointdecimal积分,默认 0,范围 -1000000.00 到 1000000.00。
discountdecimal折扣,默认 100。
creditint是否允许赊账,默认 0;大于等于 1 按 1 落库,否则按 0 落库。
enableint会员状态,只允许 0/1,默认 1。
birthdaystring公历生日,支持 yyyy-MM-ddyyyy-MM-dd HH:mm:ss
qqstringQQ,长度不超过 16。
emailstring邮箱,长度不超过 64。
addressstring地址,长度不超过 255。
remarksstring备注,长度不超过 255。
expiryDatestring过期时间,支持 yyyy-MM-ddyyyy-MM-dd HH:mm:ss
customerExtobject会员扩展资料;首期只支持 sexnickNamelunarBirthday
customerTagUidsarray<long>会员标签 UID 列表;UID 必须属于会员归属账号,重复 UID 会自动去重。

customerExt 字段

字段类型必填说明
sexint性别:1 男,0 女。
nickNamestring会员昵称,长度不超过 64。
lunarBirthdaystring阴历生日,支持 yyyy-MM-ddyyyy-MM-dd HH:mm:ss,会同步写入 lunarYearlunarMonthDay

请求示例

{
  "account": "store001",
  "number": "VIP0001",
  "tel": "13800138000",
  "name": "张三",
  "customerCategoryUid": 0,
  "validateTelUnique": true,
  "point": 0,
  "discount": 100,
  "credit": 0,
  "enable": 1,
  "birthday": "1995-08-15",
  "qq": "123456",
  "email": "test@example.com",
  "address": "厦门市",
  "remarks": "开放平台新增",
  "expiryDate": "2030-12-31 23:59:59",
  "customerTagUids": [7001, 7002],
  "customerExt": {
    "sex": 1,
    "nickName": "小张",
    "lunarBirthday": "1995-07-20"
  }
}

返回示例

{
  "status": "success",
  "errorCode": 0,
  "result": {
    "id": "27051829",
    "uid": "3002001001",
    "number": "VIP0001",
    "name": "张三",
    "tel": "13800138000",
    "customerCategoryUid": "0",
    "customerTagUids": [7001, 7002],
    "createUserId": 10001,
    "sysUpdateTime": "2026-07-23 10:00:00"
  }
}

修改会员

POST
/openapi/v3/customer/update

按会员 uidnumber 二选一定位会员,通过 updateMaskclearFields 修改会员基础资料和扩展资料。定位时包含已删除会员,因此可通过修改 enable 恢复会员。

Token 消耗 固定 100 token/次

请求参数

参数类型必填说明
accountstring目标门店账号,会员归属和门店权限沿用会员查询规则。
uidlong二选一会员 UID,与 number 必须且只能传一个。
numberstring二选一会员编号,仅作为定位条件,不支持修改。
updateMaskarray<string>条件必填需要设置的字段;与 clearFields 不能同时为空。
clearFieldsarray<string>条件必填需要清空的字段;同一字段不能同时出现在两个列表中。
validateTelUniquebooleantrue 时,修改手机号或恢复会员会排除当前会员并校验有效会员手机号唯一。
namestring会员姓名,可修改,不可清空。
telstring手机号,可修改,不可清空。
customerCategoryUidlong会员等级 UID;传 0 表示无等级,大于 0 时校验等级存在。
discountdecimal会员折扣,必须大于等于 0。
creditint是否允许赊账,只允许 0/1
enableint只允许 -1 删除、0 禁用、1 启用或恢复。
birthdaystring公历生日,支持修改或清空。
qqstringQQ,支持修改或清空。
emailstring邮箱,支持修改或清空。
addressstring地址,支持修改或清空。
remarksstring备注,支持修改或清空。
expiryDatestring到期时间,支持修改或清空。
customerExtobject扩展资料,只支持通过叶子路径修改。
customerTagUidsarray<long>会员标签 UID 列表;需在 updateMask 中加入该字段进行整体替换,UID 必须属于会员归属账号。

字段规则

  • updateMask 支持:nametelcustomerCategoryUiddiscountcreditenablebirthdayqqemailaddressremarksexpiryDatecustomerExt.sexcustomerExt.nickNamecustomerExt.lunarBirthdaycustomerTagUids
  • clearFields 支持:birthdayqqemailaddressremarksexpiryDate、三个 customerExt.xxx 字段及 customerTagUids;清空标签时不要再传 customerTagUids 请求体字段。
  • customerTagUids 按整体替换处理;传入空数组时不能用于 updateMask,如需清空全部标签请将其放入 clearFields
  • 日期字段支持 yyyy-MM-ddyyyy-MM-dd HH:mm:ss
  • 余额、赠送余额和积分不支持直接修改,请使用会员余额积分调整接口。
  • 接口只记录实际发生变化的字段;每个字段写一条 entitypropertychangelog,会员资料和日志在同一事务提交。

请求示例

{
  "account": "store001",
  "number": "VIP0001",
  "updateMask": ["name", "tel", "enable", "customerExt.nickName", "customerTagUids"],
  "clearFields": ["email", "remarks"],
  "validateTelUnique": true,
  "name": "李四",
  "tel": "13900139000",
  "enable": 1,
  "customerTagUids": [7001, 7002],
  "customerExt": {
    "nickName": "小李"
  }
}

返回示例

{
  "status": "success",
  "errorCode": 0,
  "result": {
    "id": "27051829",
    "uid": "3002001001",
    "number": "VIP0001",
    "name": "李四",
    "tel": "13900139000",
    "customerCategoryUid": "0",
    "enable": 1,
    "customerTagUids": [7001, 7002],
    "sysUpdateTime": "2026-08-27 15:30:00"
  }
}

查询会员

POST
/openapi/v3/customer/increment-page

用于按主键游标分页查询会员基础信息,可按需返回扩展资料、分类、标签。

连锁规则:如果调用方是总部 appId,传总部 account 表示查询全部会员,传子门店 account 表示只查询该子门店创建的会员;如果调用方是子门店 appId,则只能传自己的 account,且只查询自己创建的会员。

Token 消耗 基础 100 token/次 每开启一个扩展返回开关,额外 +20 token

请求参数

参数 类型 必填 说明
account string 查询范围账号。非连锁门店传当前门店账号;连锁门店中,总部 appId 传总部账号查全部会员、传子门店账号查该门店创建的会员;子门店 appId 只能传自己的账号。
uidlong按会员 UID 精确查询。
numberstring按会员编号精确查询。
namestring按会员名称精确查询。
telstring按手机号精确查询。
customerCategoryUidlong按会员分类 UID 精确查询。
customerCategoryNamestring按会员分类 名称 精确查询。
lastId long 翻页游标。首次传 0 或不传;后续传上一次响应中的 nextLastId
order string 排序方向,仅支持 ascdesc,默认 asc
limit int 分页大小,默认 100,最大 100,超过按 100 处理。
needCustomerExtbooleantrue 时返回会员扩展资料。
needCustomerCategorybooleantrue 时返回会员分类对象。
needCustomerTagbooleantrue 时返回会员标签列表。
needCustomerIdentitybooleantrue 时返回会员外部身份标识列表,字段名为 customerIdentities
needShoppingCardbooleantrue 时返回会员购物卡列表。
needArchivesbooleantrue 时返回会员档案自定义属性,字段名为 archives

请求示例

{
  "account": "store001",
  "uid": 3002001001,
  "number": "VIP0001",
  "name": "张三",
  "tel": "13800138000",
  "customerCategoryUid": 6001,
  "customerCategoryName": "金卡会员",
  "lastId": 0,
  "order": "asc",
  "limit": 100,
  "needCustomerExt": true,
  "needCustomerCategory": true,
  "needCustomerTag": false,
  "needCustomerIdentity": true,
  "needShoppingCard": true,
  "needArchives": true
}

返回示例

{
  "status": "success",
  "errorCode": 0,
  "result": {
    "list": [
      {
        "id": "201",
        "uid": "3002001001",
        "customerCategoryUid": "6001",
        "number": "VIP0001",
        "name": "张三",
        "point": "1200",
        "discount": "85",
        "money": "88.60",
        "tel": "13800138000",
        "birthday": "1990-05-20",
        "qq": "12345678",
        "email": "vip001@example.com",
        "address": "上海市浦东新区世纪大道100号",
        "remarks": "高频到店会员",
        "createdDate": "2025-01-10 12:00:00",
        "credit": 1000,
        "enable": 1,
        "account": "vip001",
        "active": 0,
        "isLoss": 0,
        "expiryDate": "2026-12-31 23:59:59",
        "guiderUid": "8001001",
        "importDate": "2025-01-10 12:00:00.0000",
        "giftMoney": 20.00,
        "isPayMember": 1,
        "birthYear": 1990,
        "birthMonthDay": 520,
        "lunarYear": 1990,
        "lunarMonthDay": 426,
        "sysUpdateTime": "2026-04-01 10:20:00",
        "createUserAccount": "store001",
        "customerExt": {
          "sex": 1,
          "photoPath": "https://cdn.example.com/customer/3002001001/avatar.jpg",
          "nickName": "三哥",
          "totalPoint": 3200,
          "totalTicketAmount": 5680.50,
          "totalRechargeAmount": 2000.00,
          "totalTicketNum": 36,
          "creditLimit": 1000.00,
          "creditPeriod": 30,
          "creditType": 1,
          "amountInArrear": 0.00,
          "contactName": "张三",
          "vipCompany": "示例商贸有限公司"
        },
        "customerCategory": {
          "uid": "6001",
          "name": "金卡会员",
          "discount": "85",
          "enable": 1,
          "isPoint": 1,
          "sortValue": 10
        },
        "customerTags": [
          "高净值",
          "常购饮料"
        ],
        "customerIdentities": [
          {
            "key": 0,
            "value": "公众号OpenID"
          },
          {
            "key": 1,
            "value": "小程序OpenID",
            "appType": 100
          },
          {
            "key": 1000,
            "value": "微信UnionID"
          },
          {
            "key": 2000,
            "value": "支付宝用户标识"
          },
          {
            "key": 4000,
            "value": "抖音用户标识"
          }
        ],
        "shoppingCards": [
          {
            "uid": "7001001",
            "name": "通用购物卡",
            "balance": 100.00,
            "giftBalance": 20.00,
            "cardType": 1,
            "purchaseDateTime": "2026-01-01 10:00:00",
            "startUseDateTime": "2026-01-01 10:00:00",
            "expireDateTime": "2026-12-31 23:59:59",
            "enable": 1,
            "isWaitToActive": 0,
            "chargeAccount": "store001"
          }
        ],
        "archives": {
          "attribute1": "示例属性1",
          "attribute2": "示例属性2"
        }
      }
    ],
    "hasMore": false,
    "nextLastId": "201"
  }
}

返回字段说明

statuserrorCode 及分页公共字段请参考“公共响应格式”,此处仅补充 result.list[] 及扩展对象。

字段 类型 说明
idstring会员主键 ID。
uidstring会员业务 UID。
customerCategoryUidstring会员分类UID。
numberstring会员编号。
namestring会员名称。
pointstring当前积分。
discountstring分类折扣。85表示85折
moneystring储值余额。
telstring手机号。
birthdaystring生日。
qqstringQQ。
emailstring邮箱地址。
addressstring联系地址。
remarksstring备注信息。
createdDatestring业务创建时间,按表字段原样返回。
creditint是否允许赊账 1 允许 0/null 不允许。
enableint会员状态,1 可用,0 禁用,-1 删除;接口仅返回 enable != -1 的会员。
accountstring会员账号。
activeint会员状态,0 为正常,-10 为挂失。
isLossint是否挂失,0/null 否,1 是。
expiryDatestring会员到期时间。
guiderUidstring导购员 UID。
importDatestring导入时间。
giftMoneydecimal剩余赠送金额,该金额已包含在 money 中。
isPayMemberint是否付费会员,0/null 否,1 是。
birthYearint公历生日年份。
birthMonthDayint公历生日月日,例如 5 月 20 日返回 520
lunarYearint农历生日年份。
lunarMonthDayint农历生日月日。
sysUpdateTimestring系统更新时间。
createUserAccountstring创建该会员的门店账号。
customerExtobject会员扩展资料,需传 needCustomerExt=true
customerCategoryobject会员分类对象,需传 needCustomerCategory=true
customerTagsarray<string>会员标签列表,需传 needCustomerTag=true
customerIdentitiesarray<object>会员外部身份标识列表,需传 needCustomerIdentity=truekey 为身份类型,value 为身份值,appType 用于区分不同小程序。
shoppingCardsarray<object>会员购物卡列表,需传 needShoppingCard=true
archivesobject会员档案自定义属性,需传 needArchives=true;包含 attribute1 ~ attribute30,未填写的属性不返回。

customerIdentities.key 类型说明

key说明
0微信公众号 OpenID
1微信小程序 OpenID(不同小程序由 appType 区分)
1000微信 UnionID
2000支付宝用户标识
4000抖音用户标识

扩展对象字段

对象 字段 类型 说明
customerExtsexint性别 1-男,0-女,NULL未填写。
customerExtphotoPathstring头像地址。
customerExtnickNamestring昵称。
customerExttotalPointdecimal累计积分。
customerExttotalTicketAmountdecimal累计消费金额。
customerExttotalRechargeAmountdecimal累计充值金额。
customerExttotalTicketNumint累计消费次数。
customerExtcreditLimitdecimal赊账额度。
customerExtcreditPeriodint账期天数。
customerExtcreditTypeint赊账类型。
customerExtamountInArreardecimal欠款金额。
customerExtcontactNamestring联系人姓名。
customerExtvipCompanystring所属公司/单位。
customerCategoryuidstring会员分类UID。
customerCategorynamestring会员分类名称。
customerCategorydiscountstring分类折扣。85表示85折
customerCategoryenableint分类启用状态。
customerCategoryisPointint是否参与积分。
customerCategorysortValueint分类排序值。
shoppingCardsuidstring购物卡 UID。
shoppingCardsnamestring购物卡名称。
shoppingCardsbalancedecimal购物卡余额。
shoppingCardsgiftBalancedecimal购物卡剩余赠送余额。
shoppingCardscardTypeint卡类型,1-通用卡,2-分期返还旧卡。
shoppingCardspurchaseDateTimestring购买时间。
shoppingCardsstartUseDateTimestring开始使用时间。
shoppingCardsexpireDateTimestring过期时间。
shoppingCardsenableint购物卡状态。
shoppingCardsisWaitToActiveint是否待激活,0-已激活,1-待激活。
shoppingCardschargeAccountstring购物卡开卡门店账号。
archivesattribute1 ~ attribute30string会员档案自定义属性,按档案表原值返回。

会员余额积分接口

会员余额积分调整

POST
/openapi/v3/customer/balance-point/adjust

用于按增量调整会员储值余额和积分。余额扣减时先扣本金,再扣赠送金额,最后允许按会员赊账额度扣成负数;幂等继续复用请求头 X-Request-Id,同时按 dataChangeTime + timeSeq 做业务防重。

Token 消耗 固定 100 token/次

请求参数

参数类型必填说明
accountstring操作门店账号。
customerUidlong会员 UID,与 customerNumber 二选一。
customerNumberstring会员编号,与 customerUid 二选一。
balanceIncrementdecimal余额增量,正数增加,负数扣减。与 pointIncrement 至少传一个非 0 值。
pointIncrementdecimal积分增量,正数增加,负数扣减。与 balanceIncrement 至少传一个非 0 值。
validateBalanceint1 时,扣余额会校验扣减后余额不能低于负的赊账额度。
validatePointint1 时,扣积分会校验积分余额不能小于 0。
dataChangeTimestring业务变动时间,格式 yyyy-MM-dd HH:mm:ss
timeSeqint业务时间序号,默认 0。同一会员同一 dataChangeTime + timeSeq 不允许重复提交。
remarkstring备注,最多 255 字符。

业务说明

  • customer.money 是会员总余额,customer.giftMoney 是总余额中剩余的赠送金额。
  • 余额增加时默认增加本金,只更新 money,不增加 giftMoney
  • 余额扣减时按本金、赠送金额、赊账额度的顺序处理,giftMoney 不会扣成负数。
  • 接口会更新 customer,并写入 customerbalnacepointchangelogentitypropertychangelog;如有备注,还会写入 entitypropertychangelogext

请求示例

{
  "account": "store001",
  "customerUid": 3002001001,
  "balanceIncrement": -10.00,
  "pointIncrement": -5.00,
  "validateBalance": 1,
  "validatePoint": 1,
  "dataChangeTime": "2026-06-12 16:30:00",
  "timeSeq": 0,
  "remark": "开放接口调整"
}

返回示例

{
  "status": "success",
  "errorCode": 0,
  "result": {
    "customerUid": "3002001001",
    "balanceBeforeUpdate": 100.00,
    "balanceAfterUpdate": 90.00,
    "balanceIncrement": -10.00,
    "giftMoneyBeforeUpdate": 20.00,
    "giftMoneyAfterUpdate": 18.00,
    "pointBeforeUpdate": 50.00,
    "pointAfterUpdate": 45.00,
    "pointIncrement": -5.00,
    "dataChangeTime": "2026-06-12 16:30:00",
    "timeSeq": 0,
    "updateCustomerTime": "2026-06-12 16:31:02"
  }
}

返回字段说明

字段类型说明
customerUidstring会员 UID。
balanceBeforeUpdatedecimal调整前会员总余额。
balanceAfterUpdatedecimal调整后会员总余额。
balanceIncrementdecimal本次余额增量。
giftMoneyBeforeUpdatedecimal调整前剩余赠送金额。
giftMoneyAfterUpdatedecimal调整后剩余赠送金额。
pointBeforeUpdatedecimal调整前积分。
pointAfterUpdatedecimal调整后积分。
pointIncrementdecimal本次积分增量。
dataChangeTimestring业务变动时间。
timeSeqint业务时间序号。
updateCustomerTimestring实际更新时间。

会员购物卡接口

购物卡余额调整

POST
/openapi/v3/customer/shopping-card/adjust-balance

用于按购物卡 UID 调整余额。当前仅支持负数扣减,扣减时先扣本金,再扣赠送金额;幂等继续复用请求头 X-Request-Id

Token 消耗 固定 100 token/次

请求参数

参数类型必填说明
accountstring操作门店账号。
shoppingCardUidlong购物卡 UID。
balancedecimal调整金额,不能等于 0。当前仅支持小于 0 的扣减,例如 -3.00 表示扣减 3 元。

业务说明

  • 仅允许扣减 enable=1delDateTime IS NULL 的购物卡。
  • 接口会按 customerUserIdshoppingCardUid 锁定购物卡并在同一事务内更新余额、写入 shoppingcardusage
  • 写入流水时固定 ticketId=0operateType=1755
  • useBalance 返回并写入本次扣减总金额,useGiftBalance 返回并写入其中的赠送金额部分,均为正数。

请求示例

{
  "account": "store001",
  "shoppingCardUid": 1781245872443715380,
  "balance": -3.00
}

返回示例

{
  "status": "success",
  "errorCode": 0,
  "result": {
    "shoppingCardUid": "1781245872443715380",
    "adjustAmount": -3.00,
    "useBalance": 3.00,
    "useGiftBalance": 0.00,
    "afterUsedBalance": 7.00,
    "afterUsedGiftBalance": 4.00
  }
}

返回字段说明

字段类型说明
shoppingCardUidstring购物卡 UID。
adjustAmountdecimal本次调整金额,负数表示扣减。
useBalancedecimal本次扣减总金额。
useGiftBalancedecimal本次扣减赠送金额。
afterUsedBalancedecimal扣减后购物卡总余额。
afterUsedGiftBalancedecimal扣减后购物卡赠送余额。

会员充值记录接口

查询会员充值记录

POST
/openapi/v3/customer/recharge-log/page

用于按会员 UID、会员编号和充值时间范围查询会员充值流水。

连锁规则:请求体 account 传总部账号时,返回总部及全部子门店充值记录;传子门店或独立门店账号时,只返回该门店充值记录。响应字段 account 表示该条充值实际发生的门店账号。

请求参数

参数类型必填说明
accountstring查询范围账号。总部账号查总部及子门店;子门店或独立门店只查本店。
customerUidlong按会员 UID 精确查询。
customerNumberstring按会员编号精确查询,对应 customer.number
datetimeBeginstring充值开始时间,格式 yyyy-MM-dd HH:mm:ss,包含该时间。
datetimeEndstring充值结束时间,格式 yyyy-MM-dd HH:mm:ss,不包含该时间,必须大于 datetimeBegin
lastIdlong翻页游标。首次传 0 或不传;后续传响应中的 nextLastId
orderstring排序方向,支持 descasc,默认 desc
limitint分页大小,默认 100,最大 100

业务说明

  • customerUidcustomerNumber 时,按会员精确查询计费,100 token
  • 未传 customerUidcustomerNumber 时,即使传了充值时间范围,也按范围查询计费,500 token
  • 默认按充值时间倒序返回;同一充值时间内按 id 排序,保证游标分页稳定。
  • 响应字段 account 是充值发生门店账号,不一定等于请求体中的查询范围账号。

请求示例

{
  "account": "head001",
  "customerUid": 3002001001,
  "customerNumber": "VIP0001",
  "datetimeBegin": "2026-04-01 00:00:00",
  "datetimeEnd": "2026-04-02 00:00:00",
  "lastId": 0,
  "order": "desc",
  "limit": 100
}

返回示例

{
  "status": "success",
  "errorCode": 0,
  "result": {
    "list": [
      {
        "id": "1102747",
        "userId": 10002,
        "account": "store002",
        "customerUid": "3002001001",
        "customerNumber": "VIP0001",
        "cashierUid": "9001001",
        "rechargeLogId": 12345,
        "rechargeMoney": 100.00,
        "giftMoney": 10.00,
        "datetime": "2026-04-01 12:30:00",
        "uid": "20260401123000001",
        "payMethod": "现金",
        "customerMoneyAfterRecharge": 188.60,
        "guiderUid": "8001001",
        "fromOrToCustomerUid": null,
        "rechargeType": 0,
        "remark": "会员充值",
        "externalOrderNo": "PAY202604010001",
        "rechargeRuleUid": "6001001",
        "rechargeRuleDesc": "充100送10",
        "payMethodCode": 1,
        "rechargeChannelCode": 1
      }
    ],
    "hasMore": false,
    "nextLastId": "1102747"
  }
}

返回字段说明

字段类型说明
idstring充值记录主键 ID。
userIdint充值发生门店 ID。
accountstring充值发生门店账号。
customerUidstring会员 UID。
customerNumberstring会员编号。
cashierUidstring收银员 UID。
rechargeLogIdint业务充值记录 ID。
rechargeMoneydecimal充值金额。
giftMoneydecimal赠送金额。
datetimestring充值时间。
uidstring充值业务 UID。
payMethodstring支付方式名称。
customerMoneyAfterRechargedecimal会员充值后的储值余额。
guiderUidstring导购 UID。
fromOrToCustomerUidstring转账关联会员 UID。
rechargeTypeint充值方式。
remarkstring备注。
externalOrderNostring外部订单号。
rechargeRuleUidstring充值规则 UID。
rechargeRuleDescstring充值规则描述。
payMethodCodeint支付方式代码。
rechargeChannelCodeint充值通道代码。