开发指南
API
官网
API 3.0
API 3.0 > 7.3 会员基础信息 > 7.3.6 会员三合一查询

7.3.6 会员三合一查询

开启令牌和权限后可调用。签名方式请查看开发指南
场景描述：会员详情（包括，基础信息，积分，余额 和优惠券列表查询）
零售 餐饮

请求地址

请求方式 版本信息 请求地址
POST V3 http://openapi.zvcms.com/v3/crm/customer/allCustomerInfo

公共参数

参数 参数类型 是否必填 默认值 描述
openId string 是 密钥Id
grantCode string 是 授权code
token string 是 签名，参考《数字签名sign》
timestamp string 是 当前时间戳
nonce string 是 随机正整数
params array 是 业务参数

请求参数

参数 参数类型 是否必填 默认值 描述
customerId string 否 customerId传用户id或者 会员码【与type字段互斥，必传一个】
channel string 否 账户名
takeTimeBegin Date 否 领取开始时间
takeTimeEnd Date 否 领取结束时间
title string 否 优惠券名称/券号
usefulTimeBegin Date 否 有效期开始时间
usefulTimeEnd Date 否 有效期结束时间
type int 否 类型：1-手机号，2-卡号，3-支付宝userid，4-微信openid，5-微信unionid
unionId string 否 type=5时，微信unionId必填
userId string 否 type=3时，支付宝userId必填
cardNo string 否 type =2时，卡号cardNo必填
phone string 否 type=1时，phone手机号必填
openId string 否 type=4时，微信openid必填
useStatus int 否 券状态:0：未使用/已冲正、1：已核销、2：已冻结、4：转赠中、5：转赠超时、6：已失效、7：已删除/已回收'
pageNum int 否 第几页
pageSize int 否 每页显示数（不传默认显示·10条）

响应参数

参数 参数类型 描述
totalPoints string 所有有效积分
expiredTime string 最近一笔积分过期时间【可忽略】
foreverPoints string 永久积分【可忽略】
soonExpiredPoints string 最近一笔30天内过期积分数量【可忽略】
giftBalance string 赠送金额
rechargeBalance string 充值金额
totalGiftAmount string 累计赠送金额
totalRechargeAmount string 累计充值金额
updatedAt int 更新时间（余额）
deletedAt int 删除时间（余额）
createdAt int 创建时间（余额）
CouponsLists array
 ├0 array
  ├beginAt int 开始时间
  ├cardId string cardId优惠券核销码
  ├couponId string couponId优惠券标识
  ├couponType string 券类型:0、现金券/折扣券 2、限制数量免单券 3、erp兑换券(线下用) 4、买M送N券 5、商品券 6、免运费/配送费券 7、免排队券 8、停车券, 12 次券
  ├createdAt string 优惠券创建时间
  ├customerId string 用户id
  ├useStatus string 劵状态:0：未使用/已冲正、1：已核销、2：已冻结、6：已失效、7：已删除/已回收
  ├endAt string 结束时间
  ├extra string 券类型描述
  ├groupId string 集团idgroupId
  ├templateId string 优惠模板id
  ├title string 优惠券名称
  ├updatedAt string 更新时间
  ├sellerName String 店铺名称
  ├sellerId int 店铺id
  ├discountAmount string 商品优惠金额/折扣(次券是优惠次数)
  ├discountUnit int 优惠单位：1：元，2：折, 3: 次
  ├thresholdType int 使用门槛类型：1、无门槛 2、满 xx 元 3、满 xx 件
  ├useThreshold int 使用门槛值
  ├couponExplain string 优惠券使用说明
detailInfo array
 ├address string 详细地址
 ├birthday string 生日
 ├cardNo string 卡号
 ├city string 城市
 ├country string 国家
 ├customerId string 用户id
 ├district string 地区
 ├gender string 性别 0："未知",1："男，2,："女"
 ├memberLevel string 会员卡等级
 ├mobilePhone string 手机号
 ├openingCardDate string 开卡日期
 ├province string 省份
 ├storeName string 注册店铺名
 ├username string 用户真实姓名
 ├useNum int 用户可用优惠券数量
 ├expiredNum int 已失效优惠券数量
 ├hadUseNum int 已使用优惠券数量

请求示例

{
    "openId": "6dc05b4ac175cf316d226252b05cf685",
    "grantCode": "782c281f62",
    "timestamp": "1547186244",
    "nonce": "658965",
    "token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "params": {
        "customerId": "383933091455959041",
        "channel": "",
        "takeTimeBegin": "2019-08-13",
        "takeTimeEnd": "2019-08-13",
        "title": "",
        "usefulTimeBegin": "2019-08-13",
        "usefulTimeEnd": "2019-08-13",
        "type": "1",
        "unionId": "",
        "userId": "",
        "cardNo": "",
        "phone": "15861815286",
        "openId": "",
        "useStatus": "1",
        "pageNum": "1",
        "pageSize": ""
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": {
        "totalPoints": "1010",
        "expiredTime": "",
        "foreverPoints": "",
        "soonExpiredPoints": "",
        "giftBalance": "700",
        "rechargeBalance": "586.07",
        "totalGiftAmount": "700",
        "totalRechargeAmount": "700",
        "updatedAt": "1569757768000",
        "deletedAt": "",
        "createdAt": "1569476992000",
        "CouponsLists": [
            {
                "beginAt": "2019-09-30 00:00:00",
                "cardId": "385228477160226816",
                "couponId": "385228477189586944",
                "couponType": "0",
                "createdAt": "2019-09-30 00:40:26",
                "customerId": "383933091455959041",
                "useStatus": "0",
                "endAt": "2019-09-30 23:59:59",
                "extra": "null",
                "groupId": "",
                "templateId": "865",
                "title": "带图",
                "updatedAt": "2011-01-02",
                "sellerName": "",
                "sellerId": "",
                "discountAmount": "2",
                "discountUnit": "1",
                "thresholdType": "1",
                "useThreshold": "0",
                "couponExplain": ""
            }
        ],
        "detailInfo": {
            "address": "详细地址",
            "birthday": "2011-01-02",
            "cardNo": "383933091455959041",
            "city": "120100",
            "country": "",
            "customerId": "383933091455959041",
            "district": "120101",
            "gender": "性别",
            "memberLevel": "会员卡等级",
            "mobilePhone": "手机号",
            "openingCardDate": "开卡日期",
            "province": "120000",
            "storeName": "注册店铺名",
            "username": "用户真实姓名",
            "useNum": "2",
            "expiredNum": "0",
            "hadUseNum": "1"
        }
    }
}

异常示例

{
    "status": true,
    "code": "异常编码，根据不同的业务返回编码",
    "message": "异常说明：查询的信息不存在"
}

错误码

{
    "status": false,
    "code": "系统错误编码：详见全局返回编码",
    "message": "系统错误说明"
}

请求地址

请求方式 版本信息 请求地址
POST V3 http://openapi.zvcms.com/v3/crm/customer/allCustomerInfo

公共参数

参数 参数类型 是否必填 默认值 描述
openId string 是 密钥Id
grantCode string 是 授权code
token string 是 签名，参考《数字签名sign》
timestamp string 是 当前时间戳
nonce string 是 随机正整数
params array 是 业务参数

请求参数

参数 参数类型 是否必填 默认值 描述
customerId string 否 customerId传用户id或者 会员码【与type字段互斥，必传一个】
channel string 否 账户名
takeTimeBegin Date 否 领取开始时间
takeTimeEnd Date 否 领取结束时间
title string 否 优惠券名称/券号
usefulTimeBegin Date 否 有效期开始时间
usefulTimeEnd Date 否 有效期结束时间
type int 否 类型：1-手机号，2-卡号，3-支付宝userid，4-微信openid，5-微信unionid
unionId string 否 type=5时，微信unionId必填
userId string 否 type=3时，支付宝userId必填
cardNo string 否 type =2时，卡号cardNo必填
phone string 否 type=1时，phone手机号必填
openId string 否 type=4时，微信openid必填
useStatus int 否 券状态:0：未使用/已冲正、1：已核销、2：已冻结、4：转赠中、5：转赠超时、6：已失效、7：已删除/已回收'
pageNum int 否 第几页
pageSize int 否 每页显示数（不传默认显示·10条）

响应参数

参数 参数类型 描述
totalPoints string 所有有效积分
expiredTime string 最近一笔积分过期时间【可忽略】
foreverPoints string 永久积分【可忽略】
soonExpiredPoints string 最近一笔30天内过期积分数量【可忽略】
giftBalance string 赠送金额
rechargeBalance string 充值金额
totalGiftAmount string 累计赠送金额
totalRechargeAmount string 累计充值金额
updatedAt int 更新时间（余额）
deletedAt int 删除时间（余额）
createdAt int 创建时间（余额）
CouponsLists array
 ├0 array
  ├beginAt int 开始时间
  ├cardId string cardId优惠券核销码
  ├couponId string couponId优惠券标识
  ├couponType string 券类型:0、现金券/折扣券 2、限制数量免单券 3、erp兑换券(线下用) 4、买M送N券 5、商品券 6、免运费/配送费券 7、免排队券 8、停车券, 12 次券
  ├createdAt string 优惠券创建时间
  ├customerId string 用户id
  ├useStatus string 劵状态:0：未使用/已冲正、1：已核销、2：已冻结、6：已失效、7：已删除/已回收
  ├endAt string 结束时间
  ├extra string 券类型描述
  ├groupId string 集团idgroupId
  ├templateId string 优惠模板id
  ├title string 优惠券名称
  ├updatedAt string 更新时间
  ├sellerName String 店铺名称
  ├sellerId int 店铺id
  ├discountAmount string 商品优惠金额/折扣(次券是优惠次数)
  ├discountUnit int 优惠单位：1：元，2：折, 3: 次
  ├thresholdType int 使用门槛类型：1、无门槛 2、满 xx 元 3、满 xx 件
  ├useThreshold int 使用门槛值
  ├couponExplain string 优惠券使用说明
  ├thirdBizCode string 三方业务券编码
  ├useChannel string 使用渠道，1-小程序（线上），2-POS机（线下）,3-windows收银机；4-andriod收银机；5-蜻蜓；6-如意RO，多个逗号分隔，如1,2
  ├origin_count int 初始次数(次券使用)
  ├usable_count int 可用次数(次券使用)
  ├memberDiscountSet int 会员折扣设置： 1-入会员折扣 2-不入会员折扣
detailInfo array
 ├address string 详细地址
 ├birthday string 生日
 ├cardNo string 卡号
 ├city string 城市
 ├country string 国家
 ├customerId string 用户id
 ├district string 地区
 ├gender string 性别 0："未知",1："男，2,："女"
 ├memberLevel string 会员卡等级
 ├mobilePhone string 手机号
 ├openingCardDate string 开卡日期
 ├province string 省份
 ├storeName string 注册店铺名
 ├username string 用户真实姓名
 ├useNum int 用户可用优惠券数量
 ├expiredNum int 已失效优惠券数量
 ├hadUseNum int 已使用优惠券数量
pointsRule array
 ├points_rule string 100 100积分兑换1元

请求示例

{
    "openId": "6dc05b4ac175cf316d226252b05cf685",
    "grantCode": "782c281f62",
    "timestamp": "1547186244",
    "nonce": "658965",
    "token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "params": {
        "customerId": "383933091455959041",
        "channel": "",
        "takeTimeBegin": "2019-08-13",
        "takeTimeEnd": "2019-08-13",
        "title": "",
        "usefulTimeBegin": "2019-08-13",
        "usefulTimeEnd": "2019-08-13",
        "type": "1",
        "unionId": "",
        "userId": "",
        "cardNo": "",
        "phone": "15861815286",
        "openId": "",
        "useStatus": "1",
        "pageNum": "1",
        "pageSize": ""
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": {
        "totalPoints": "1010",
        "expiredTime": "",
        "foreverPoints": "",
        "soonExpiredPoints": "",
        "giftBalance": "700",
        "rechargeBalance": "586.07",
        "totalGiftAmount": "700",
        "totalRechargeAmount": "700",
        "updatedAt": "1569757768000",
        "deletedAt": "",
        "createdAt": "1569476992000",
        "CouponsLists": [
            {
                "beginAt": "2019-09-30 00:00:00",
                "cardId": "385228477160226816",
                "couponId": "385228477189586944",
                "couponType": "0",
                "createdAt": "2019-09-30 00:40:26",
                "customerId": "383933091455959041",
                "useStatus": "0",
                "endAt": "2019-09-30 23:59:59",
                "extra": "null",
                "groupId": "",
                "templateId": "865",
                "title": "带图",
                "updatedAt": "2011-01-02",
                "sellerName": "",
                "sellerId": "",
                "discountAmount": "2",
                "discountUnit": "1",
                "thresholdType": "1",
                "useThreshold": "0",
                "couponExplain": "",
                "thirdBizCode": "",
                "useChannel": "",
                "origin_count": "",
                "usable_count": "",
                "memberDiscountSet": ""
            }
        ],
        "detailInfo": {
            "address": "详细地址",
            "birthday": "2011-01-02",
            "cardNo": "383933091455959041",
            "city": "120100",
            "country": "",
            "customerId": "383933091455959041",
            "district": "120101",
            "gender": "性别",
            "memberLevel": "会员卡等级",
            "mobilePhone": "手机号",
            "openingCardDate": "开卡日期",
            "province": "120000",
            "storeName": "注册店铺名",
            "username": "用户真实姓名",
            "useNum": "2",
            "expiredNum": "0",
            "hadUseNum": "1"
        },
        "pointsRule": {
            "points_rule": "100"
        }
    }
}

异常示例

{
    "status": true,
    "code": "异常编码，根据不同的业务返回编码",
    "message": "异常说明：查询的信息不存在"
}

错误码

{
    "status": false,
    "code": "系统错误编码：详见全局返回编码",
    "message": "系统错误说明"
}

免费升级

营销功能、插件持续每月更新开发升级

免费专业培训

每月建站、微信营销、电商等互联网增值培训

7×24小时服务支持

400电话、QQ、微信、在线等多渠道售后支持

 

安徽智迈科技股份有限公司 版权所有 Copyright 2009-2018 皖公网安备 34019202000074号 增值电信业务经营许可证：皖B2-20170075