企迈云-开放平台

API 2.0

API 2.0 > 7.3 会员基础信息 > 7.3.10 查询店铺会员列表

7.3.10 查询店铺会员列表

开启令牌和权限后可调用。签名方式请查看开发指南

根据条件搜索会员

零售餐饮

请求地址

请求方式	版本信息	请求地址
POST	V2	http://openapi.zvcms.com/api/v2

公共参数

参数	参数类型	是否必填	默认值	描述
OpenId	string	是		密钥Id
GrantCode	string	是		授权code
Token	string	是		签名，参考《数字签名sign》
Timestamp	string	是		当前时间戳
Nonce	string	是		随机正整数
Action	string	是	communal.user.search-user-list	接口方法
Params	array	是		业务参数

请求参数

参数	参数类型	是否必填	默认值	描述
pageNum	int	否	1	页码
pageSize	int	否	10	分页页大小,最大1000
phone	string	否		手机号码
enterTimeStart	string	否		入会时间-开始(年-月-日时:分:秒)
enterTimeEnd	string	否		入会时间-结束(年-月-日时:分:秒)

响应参数

参数	参数类型	描述
pageNum	int	当前页码
total	int	总条数
list	array
├0	array
├birthday	string	出生日
├cardName	string	会员卡名称
├city	string	城市
├customerId	string	会员id
├enterTime	string	入会时间
├gender	string	性别
├memberBalance	string	剩余储值
├memberCoupons	int	可用优惠券数量
├memberLevel	int	会员等级
├memberOrigin	string	会员来源:wechat-微信小程序,alipay-支付宝小程序,manual-手动注册,others-三方对接,meituan-美团外卖,youzan-有赞
├memberPoints	number	可用积分
├mobilePhone	string	手机号
├storeId	string	门店id
├storeName	string	门店名
├username	string	用户名

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "communal.user.search-user-list",
    "Params": {
        "pageNum": "",
        "pageSize": "",
        "phone": "",
        "enterTimeStart": "",
        "enterTimeEnd": ""
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": {
        "pageNum": "",
        "total": "",
        "list": [
            {
                "birthday": "",
                "cardName": "",
                "city": "",
                "customerId": "",
                "enterTime": "",
                "gender": "",
                "memberBalance": "",
                "memberCoupons": "",
                "memberLevel": "",
                "memberOrigin": "",
                "memberPoints": "",
                "mobilePhone": "",
                "storeId": "",
                "storeName": "",
                "username": ""
            }
        ]
    }
}

异常示例

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

错误码

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

请求地址

请求方式	版本信息	请求地址
POST	V2	http://openapi.zvcms.com/api/v2

公共参数

参数	参数类型	是否必填	默认值	描述
OpenId	string	是		密钥Id
GrantCode	string	是		授权code
Token	string	是		签名，参考《数字签名sign》
Timestamp	string	是		当前时间戳
Nonce	string	是		随机正整数
Action	string	是	communal.user.search-user-list	接口方法
Params	array	是		业务参数

请求参数

参数	参数类型	是否必填	默认值	描述
pageNum	int	否	1	页码
pageSize	int	否	10	分页页大小,最大1000
phone	string	否		手机号码
enterTimeStart	string	否		入会时间-开始(年-月-日时:分:秒)
enterTimeEnd	string	否		入会时间-结束(年-月-日时:分:秒)

响应参数

参数	参数类型	描述
pageNum	int	当前页码
total	int	总条数
list	array
├0	array
├birthday	string	出生日
├cardName	string	会员卡名称
├city	string	城市
├customerId	string	会员id
├enterTime	string	入会时间
├gender	string	性别
├memberBalance	string	剩余储值
├memberCoupons	int	可用优惠券数量
├memberLevel	int	会员等级
├memberOrigin	string	会员来源:wechat-微信小程序,alipay-支付宝小程序,manual-手动注册,others-三方对接,meituan-美团外卖,youzan-有赞
├memberPoints	number	可用积分
├mobilePhone	string	手机号
├storeId	string	门店id
├storeName	string	门店名
├username	string	用户名

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "communal.user.search-user-list",
    "Params": {
        "pageNum": "",
        "pageSize": "",
        "phone": "",
        "enterTimeStart": "",
        "enterTimeEnd": ""
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": {
        "pageNum": "",
        "total": "",
        "list": [
            {
                "birthday": "",
                "cardName": "",
                "city": "",
                "customerId": "",
                "enterTime": "",
                "gender": "",
                "memberBalance": "",
                "memberCoupons": "",
                "memberLevel": "",
                "memberOrigin": "",
                "memberPoints": "",
                "mobilePhone": "",
                "storeId": "",
                "storeName": "",
                "username": ""
            }
        ]
    }
}

异常示例

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

错误码

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