2.5. 查询会员持有的权益集合
接口介绍:
API endpoint: {api_domain}/api/lite-member/v1/members
Verb: POST
Signature :需要签名,参考统一签名说明
请求参数:
参数 | 必填 | 类型 | 约束 | 描述 |
---|---|---|---|---|
brand_code | 1 | String | 数字,最大 32 位 | 品牌编号,系统对接前由“收钱吧”提供 |
user_channel | 1 | String | 字符串,最大 36 位 | 会员渠道。1, wechat; 2, alipay; 3, 手机号 |
user_id | 1 | String | 字符串,最大255 位 | 微信用户为 UnionID,支付宝为用户 ID,手机号用户为手机号 |
country_code | 0-1 | String | 字符串,最大36位 | 手机号区号,比如"86",如果会员渠道为3且传入手机号区号,则根据手机号码和区号去查询 |
client_member_id | 0-1 | String | 字符串,最大 36 位 | 商户端的用户 id |
balance_filter | 0-1 | String | 数字,1 位 | 0-不过滤;1-仅返回余额大于0的卡以及未被核销的券 不传该参数则不进行余额过滤 |
expired_filter | 0-1 | String | 数字,1 位 | 0-不过滤;1-仅返回未过期的卡和券 不传该参数则不进行过期过滤 |
返回参数:
参数 | 必填 | 类型 | 约束 | 描述 |
---|---|---|---|---|
brand_code | 1 | String | 数字,最大 32 位 | 品牌编号,返回调用方传入的值 |
user_id | 1 | String | 字符串,最大 36 位 | 微信用户为 UnionID,支付宝为用户 ID,手机号用户为手机号 |
user_channel | 1 | String | 字符串,最大 36 位 | 1, wechat; 2,alipay; 3, 手机号 |
client_member_id | 0-1 | String | 字符串,最大 36 位 | 商户端的用户 id |
merchant_sn | 0-1 | String | 字符串,最大 36 位 | 发卡商户编号 |
merchant_name | 0-1 | String | 字符串,最大 80 位 | 发卡商户名称 |
account_balance | 1 | String | 字符串,最大 11 位 | 账户总余额,以分为单位 |
account_available_balance | 1 | String | 字符串,最大 11 位 | 账户总可用余额,以分为单位 |
loyalty_tiers | 0-1 | String | 字符串,最大 10 位 | 预设字段,会员等级,枚举类型 |
vip_tags | 0-1 | String[] | 数组,字符串元素 | 预设字段,会员等级标签,以字符串为元素的数组 |
benefits | 1 | Array | - | 用户持有的会员卡券的集合 |
account_saled_price | 1 | String | 单位分,该会员名下历史购卡总面额 | |
account_redeemed_balance | 1 | String | 单位分,该会员名下历史核销总面额 |
备注:如果用户尚未拥有会员卡/券,则benefits为空数组,benefits的具体定义见下的‘benefits’
benefits:
参数 | 必填 | 类型 | 约束 | 描述 |
---|---|---|---|---|
number | 1 | String | 字符串,最大 36 位 | 卡/券号 |
name | 1 | String | 字符串,最大 36 位 | 卡/券名 |
type | 1 | String | 字符串,最大 4 位 | 1:礼品卡;2:券;3:储值账户 |
surface_id | 1 | String | 字符串 | 卡/券面 id |
spec_id | 1 | String | 字符串 | 卡/券规则 id |
surface_name | 0-1 | String | 字符串,最大 36 位 | 卡/券面名称 |
surface_url | 0-1 | String | 字符串 | 卡/券面图片地址 |
denomination | 1 | String | 字符串,最大 20 位 | 面额,以分为单位 |
balance | 1 | String | 字符串,最大 20 位 | 余额,以分为单位 |
net_balance | 1 | String | 字符串,最大 20 位 | 净额,以分为单位 |
discount_rate | 1 | String | 字符串,最大 20 位 | 折扣率 |
status | 1 | String | 字符串,最大 4 位 | 卡/券状态 1:未激活(未领取/转赠中) 2:已激活(已领取) 3:已过期 4:冻结中(退卡券中) 6:已失效(已退卡券) |
received_at | 1 | String | 字符串,13 位 | 领取时间,毫秒级时间戳 |
disabled_at | 1 | String | 字符串,13 位 | 失效时间,毫秒级时间戳 |
sku_spec_id | 0-1 | String | 字符串,最大128 位 | (券)对应商品的 sku 的规则 id。 规则 id对应商家端可能是一个 sku,也可能是一组 sku |
sku_spec_names | 0-1 | String | 字符串,最大128 位 | (券)对应商品的 sku 的名称列表,以逗号分割。 会显示在发卡助手核券的确认页面,供店员核对 |
issue_store_id | 0-1 | String | 字符串,最大 36 位 | 发行门店 id |
issue_store_name | 0-1 | String | 字符串,最大 128 位 | 发行门店名 |
exchange_no | 0-1 | String | 字符串,最大 128 位 | (券)兑换码 |