欧珀莱麒麟CRM对外接口


P1-会员查询

<p><strong>简要描述:</strong> </p> <ul> <li>会员信息查询</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li>环境地址: <code>https://kylinapi.aupres.com.cn/openapi/v2/member/query</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>GET </li> <li>HTTP接口</li> </ul> <p><strong>请求参数:</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">说明</th> <th>类型</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">cardNo</td> <td style="text-align: left;">N</td> <td style="text-align: left;">会员卡号, memberId,mobile,cardNo三种参数至少输入一</td> <td>string</td> </tr> <tr> <td style="text-align: left;">channelType</td> <td style="text-align: left;">N</td> <td style="text-align: left;">渠道来源 POS</td> <td>string</td> </tr> <tr> <td style="text-align: left;">memberId</td> <td style="text-align: left;">N</td> <td style="text-align: left;">会员ID , memberId,mobile,cardNo三种参数至少输入一</td> <td>string</td> </tr> <tr> <td style="text-align: left;">memberType</td> <td style="text-align: left;">Y</td> <td style="text-align: left;">会员类型 传固定值aupres</td> <td>string</td> </tr> <tr> <td style="text-align: left;">mobile</td> <td style="text-align: left;">N</td> <td style="text-align: left;">手机号码 , memberId,mobile,cardNo三种参数至少输入一</td> <td>string</td> </tr> </tbody> </table> <p><strong>响应参数:</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必传</th> <th>说明</th> <th>类型</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">address</td> <td style="text-align: left;">N</td> <td>联系地址(中文)</td> <td>String</td> </tr> <tr> <td style="text-align: left;">age</td> <td style="text-align: left;">N</td> <td>年龄</td> <td>integer(int32)</td> </tr> <tr> <td style="text-align: left;">birthDay</td> <td style="text-align: left;">N</td> <td>会员生日-月日 格式: MM-dd 例:07-05</td> <td>String</td> </tr> <tr> <td style="text-align: left;">birthYear</td> <td style="text-align: left;">N</td> <td>会员生日-年 格式: yyyy 例:1988</td> <td>String</td> </tr> <tr> <td style="text-align: left;">cardNo</td> <td style="text-align: left;">N</td> <td>会员卡号</td> <td>String</td> </tr> <tr> <td style="text-align: left;">cityCode</td> <td style="text-align: left;">N</td> <td>市 code</td> <td>String</td> </tr> <tr> <td style="text-align: left;">cityName</td> <td style="text-align: left;">N</td> <td>城市名称</td> <td>String</td> </tr> <tr> <td style="text-align: left;">country</td> <td style="text-align: left;">N</td> <td>国籍</td> <td>String</td> </tr> <tr> <td style="text-align: left;">customizedProperties</td> <td style="text-align: left;">N</td> <td>扩展属性</td> <td>object</td> </tr> <tr> <td style="text-align: left;">districtCode</td> <td style="text-align: left;">N</td> <td>区code(数据字典定义)</td> <td>String</td> </tr> <tr> <td style="text-align: left;">districtName</td> <td style="text-align: left;">N</td> <td>区名称</td> <td>String</td> </tr> <tr> <td style="text-align: left;">email</td> <td style="text-align: left;">N</td> <td>邮箱地址</td> <td>String</td> </tr> <tr> <td style="text-align: left;">firstRegisterChannelType</td> <td style="text-align: left;">N</td> <td>首次注册渠道 POS、WECHAT、WECHAT_MALL、TAOBAO 、GW 、其它(历史渠道初始化逻辑1、2属于POS 3属于GW 4、7、8、9属于其他渠道 5属于wechat 6属于天猫TAOBAO)</td> <td>String</td> </tr> <tr> <td style="text-align: left;">firstRegisterChannelTypeDesc</td> <td style="text-align: left;">N</td> <td>首次注册渠道描述</td> <td>String</td> </tr> <tr> <td style="text-align: left;">gender</td> <td style="text-align: left;">N</td> <td>性别 F:女 M:男 O:其他</td> <td>String</td> </tr> <tr> <td style="text-align: left;">headImgUrl</td> <td style="text-align: left;">N</td> <td>头像URL</td> <td>String</td> </tr> <tr> <td style="text-align: left;">identityCard</td> <td style="text-align: left;">N</td> <td>身份证号码</td> <td>String</td> </tr> <tr> <td style="text-align: left;">job</td> <td style="text-align: left;">N</td> <td>职业名称</td> <td>String</td> </tr> <tr> <td style="text-align: left;">memberBinding</td> <td style="text-align: left;">N</td> <td>会员渠道信息</td> <td>Array</td> </tr> <tr> <td style="text-align: left;">memberId</td> <td style="text-align: left;">N</td> <td>会员ID 全网唯一标识符, 最大长度为32</td> <td>String</td> </tr> <tr> <td style="text-align: left;">memberName</td> <td style="text-align: left;">N</td> <td>会员姓名</td> <td>String</td> </tr> <tr> <td style="text-align: left;">memberType</td> <td style="text-align: left;">N</td> <td>会员类型 固定值 aupres</td> <td>String</td> </tr> <tr> <td style="text-align: left;">mobile</td> <td style="text-align: left;">N</td> <td>手机号码</td> <td>String</td> </tr> <tr> <td style="text-align: left;">provinceCode</td> <td style="text-align: left;">N</td> <td>省 code(数据字典定义)</td> <td>String</td> </tr> <tr> <td style="text-align: left;">provinceName</td> <td style="text-align: left;">N</td> <td>省份名称</td> <td>String</td> </tr> <tr> <td style="text-align: left;">registerTime</td> <td style="text-align: left;">N</td> <td>注册时间 格式: yyyy-MM-dd HH:mm:ss 若不传,则默认为当前时间</td> <td>String</td> </tr> <tr> <td style="text-align: left;">shopCode</td> <td style="text-align: left;">N</td> <td>注册门店code</td> <td>String</td> </tr> <tr> <td style="text-align: left;">shopName</td> <td style="text-align: left;">N</td> <td>注册门店名称</td> <td>String</td> </tr> <tr> <td style="text-align: left;">shopTypeCode</td> <td style="text-align: left;">N</td> <td>注册门店类型code</td> <td>String</td> </tr> <tr> <td style="text-align: left;">unionId</td> <td style="text-align: left;">N</td> <td>unionId</td> <td>String</td> </tr> <tr> <td style="text-align: left;">wechatNick</td> <td style="text-align: left;">N</td> <td>微信昵称</td> <td>String</td> </tr> </tbody> </table> <p><strong>customizedProperties说明:</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">说明</th> <th>类型</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">point</td> <td style="text-align: left;">否</td> <td style="text-align: left;">有效积分</td> <td>String</td> </tr> <tr> <td style="text-align: left;">registerBc</td> <td style="text-align: left;">否</td> <td style="text-align: left;">录入BC</td> <td>String</td> </tr> <tr> <td style="text-align: left;">description</td> <td style="text-align: left;">否</td> <td style="text-align: left;">备注</td> <td>String</td> </tr> <tr> <td style="text-align: left;">thankGift</td> <td style="text-align: left;">否</td> <td style="text-align: left;">答谢回数</td> <td>String</td> </tr> <tr> <td style="text-align: left;">currentConsumeTimes</td> <td style="text-align: left;">否</td> <td style="text-align: left;">当年购买次数</td> <td>String</td> </tr> <tr> <td style="text-align: left;">currentConsumeAmount</td> <td style="text-align: left;">否</td> <td style="text-align: left;">当年购买金额</td> <td>String</td> </tr> <tr> <td style="text-align: left;">creater</td> <td style="text-align: left;">否</td> <td style="text-align: left;">创建人</td> <td>String</td> </tr> <tr> <td style="text-align: left;">updater</td> <td style="text-align: left;">否</td> <td style="text-align: left;">更新人</td> <td>String</td> </tr> <tr> <td style="text-align: left;">allergyProducts</td> <td style="text-align: left;">否</td> <td style="text-align: left;">过敏产品信息</td> <td>String</td> </tr> <tr> <td style="text-align: left;">expireDate</td> <td style="text-align: left;">否</td> <td style="text-align: left;">过期时间</td> <td>String</td> </tr> <tr> <td style="text-align: left;">gradeCode</td> <td style="text-align: left;">否</td> <td style="text-align: left;">会员等级代码</td> <td>String</td> </tr> <tr> <td style="text-align: left;">memberIdentity</td> <td style="text-align: left;">否</td> <td style="text-align: left;">会员区分 0-新会员,1-老会员,2-潜在顾客(默认),3-流失会员,4-散客</td> <td>String</td> </tr> <tr> <td style="text-align: left;">totalPurchaseTime</td> <td style="text-align: left;">否</td> <td style="text-align: left;">总购买次数</td> <td>String</td> </tr> <tr> <td style="text-align: left;">lastPurchaseDate</td> <td style="text-align: left;">否</td> <td style="text-align: left;">末次购买日</td> <td>String</td> </tr> <tr> <td style="text-align: left;">isRecommended</td> <td style="text-align: left;">否</td> <td style="text-align: left;">是否被推荐(Y:是,N:否)</td> <td>String</td> </tr> <tr> <td style="text-align: left;">isElectronicMember</td> <td style="text-align: left;">否</td> <td style="text-align: left;">是否电子会员卡会员 (Y:是,N:否)</td> <td>String</td> </tr> <tr> <td style="text-align: left;">isWechatFan</td> <td style="text-align: left;">否</td> <td style="text-align: left;">是否关注公众号 (Y:是,N:否)</td> <td>String</td> </tr> <tr> <td style="text-align: left;">isWebsideMember</td> <td style="text-align: left;">否</td> <td style="text-align: left;">是否官网会员(Y:是,N:否)</td> <td>String</td> </tr> <tr> <td style="text-align: left;">isBcWechatFriend</td> <td style="text-align: left;">否</td> <td style="text-align: left;">是否和BC为企业微信好友(Y:是,N:否)</td> <td>String</td> </tr> <tr> <td style="text-align: left;">doNotMessage</td> <td style="text-align: left;">否</td> <td style="text-align: left;">是否接收短信(1:是,0:否)</td> <td>String</td> </tr> <tr> <td style="text-align: left;">doNotEMail</td> <td style="text-align: left;">否</td> <td style="text-align: left;">是否接收邮件(1:是,0:否)</td> <td>String</td> </tr> <tr> <td style="text-align: left;">doNotMobile</td> <td style="text-align: left;">否</td> <td style="text-align: left;">是否接收电话(1:是,0:否)</td> <td>String</td> </tr> <tr> <td style="text-align: left;">isPosMember</td> <td style="text-align: left;">否</td> <td style="text-align: left;">是否门店会员(Y:是,N:否)</td> <td>String</td> </tr> <tr> <td style="text-align: left;">isTMallMember</td> <td style="text-align: left;">否</td> <td style="text-align: left;">是否天猫会员(Y:是,N:否)</td> <td>String</td> </tr> <tr> <td style="text-align: left;">isWechatMallMember</td> <td style="text-align: left;">否</td> <td style="text-align: left;">是否微商城会员(Y:是,N:否)</td> <td>String</td> </tr> <tr> <td style="text-align: left;">isBranchRegister</td> <td style="text-align: left;">否</td> <td style="text-align: left;">是否分公司录入 (1:是,0:否)</td> <td>String</td> </tr> <tr> <td style="text-align: left;">club</td> <td style="text-align: left;">否</td> <td style="text-align: left;">所属俱乐部</td> <td>String</td> </tr> <tr> <td style="text-align: left;">energizerFrequentUser</td> <td style="text-align: left;">否</td> <td style="text-align: left;">育肤爱用者</td> <td>String</td> </tr> <tr> <td style="text-align: left;">lastPurchaseBc</td> <td style="text-align: left;">否</td> <td style="text-align: left;">最后一次购买时的服务BC</td> <td>String</td> </tr> <tr> <td style="text-align: left;">lastPurchaseShop</td> <td style="text-align: left;">否</td> <td style="text-align: left;">末次购买门店</td> <td>String</td> </tr> <tr> <td style="text-align: left;">belongBc</td> <td style="text-align: left;">否</td> <td style="text-align: left;">专属BC</td> <td>String</td> </tr> <tr> <td style="text-align: left;">refereeId</td> <td style="text-align: left;">否</td> <td style="text-align: left;">推荐会员号</td> <td>String</td> </tr> <tr> <td style="text-align: left;">age</td> <td style="text-align: left;">否</td> <td style="text-align: left;">会员年龄</td> <td>Integer</td> </tr> <tr> <td style="text-align: left;">relativeShopCode</td> <td style="text-align: left;">否</td> <td style="text-align: left;">关系店代码</td> <td>String</td> </tr> <tr> <td style="text-align: left;">serviceStore</td> <td style="text-align: left;">否</td> <td style="text-align: left;">服务门店编码</td> <td>String</td> </tr> <tr> <td style="text-align: left;">serviceBc</td> <td style="text-align: left;">否</td> <td style="text-align: left;">服务BC编码</td> <td>String</td> </tr> </tbody> </table> <p><strong>响应码</strong> </p> <table> <thead> <tr> <th style="text-align: left;">HTTP Code</th> <th style="text-align: left;">Description</th> <th>Schema</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">200</td> <td style="text-align: left;">查询会员信息</td> <td><code>会员信息</code></td> </tr> <tr> <td style="text-align: left;">401</td> <td style="text-align: left;">Unauthorized</td> <td>No Content</td> </tr> <tr> <td style="text-align: left;">403</td> <td style="text-align: left;">Forbidden</td> <td>No Content</td> </tr> <tr> <td style="text-align: left;">404</td> <td style="text-align: left;">Not Found</td> <td>No Content</td> </tr> </tbody> </table> <p><strong>channelType说明</strong> </p> <ul> <li>原系统 1-专柜 2-直营店 对应麒麟 POS</li> <li>原系统 3-官网 对应麒麟 GW</li> <li>原系统 4-CRM 7-智慧门店 8-线上报名系统 9-轻店 对应麒麟 其它</li> <li>原系统 5-微信 对应麒麟 WECHAT </li> <li>原系统 6-天猫 对应麒麟 TAOBAO </li> </ul> <p><strong>请求参数示例:</strong> </p> <pre><code>https://kylinrest.aupres.com.cn/openapi/v2/member/query?memberType=aupres&amp;channelType=POS&amp;mobile=17611111116</code></pre> <p><strong>响应示例:</strong> </p> <pre><code>{ "memberType": "aupres", "memberName": "yang", "gender": "M", "cardNo": "b2b00c7f417d44938030b1bd7d1846f6", "identityCard": "235407195106112745", "birthYear": "1997", "birthDay": "01-01", "country": "china", "provinceName": "shanghaishi", "cityName": "shanghaishi", "districtName": "xuhui", "address": "上海市徐汇区天钥桥路1001号", "job": "teacher", "registerTime": "2019-11-12T10:10:10.000+08:00", "customizedProperties": { "relativeShopCode": "", "relativeShop": "", "point": "7850", "thankGift": "3", "currentConsumeTimes": 5, "currentConsumeAmount": 17000, "gradeCode": "60006", "memberIdentity": "1", "totalPurchaseTime": 5, "lastPurchaseDate": "2021-12-20T07:53:03.000Z", "isElectronicMember": true, "isWechatFan": false, "isBcWechatFriend": true, "isWechatMallMember": true, "lastPurchaseBc": "0001", "lastPurchaseShop": "秦皇岛茂业百货有限公司(秦皇岛商城店)(AP)", "belongBc": "", "age": 25, "unionId": "WECHAT_MALLT_1111" }, "mobile": "17629232170", "email": "10001@shuyun.com", "memberId": "M2021121700000001", "memberBinding": [ { "memberType": "aupres", "customerNo": "appId28154751841_WECHAT_MALL_17629232170", "appId": "appId28154751841", "openId": "WECHAT_MALL_17629232170", "appTypeCode": "WECHAT_OFFICIAL_ACCOUNT", "appTypeName": "微信公众号", "channelType": "WECHAT_MALL", "relType": 0, "unionId": "WECHAT_MALL_17629232170" }, { "memberType": "aupres", "customerNo": "WECHAT_17629232170_WECHAT_17629232170", "appId": "WECHAT_17629232170", "openId": "WECHAT_17629232170", "appTypeCode": "WECHAT_OFFICIAL_ACCOUNT", "appTypeName": "微信公众号", "channelType": "WECHAT", "relType": 1, "unionId": "WECHAT_17629232170" } ], "firstRegisterChannelType": "WECHAT_MALL", "firstRegisterChannelTypeDesc": "微商城", "age": 25, "wechatNick": "杨", "headImgUrl": "http://www.xx.com/url?id=13256", "unionId": "WECHAT_MALLT_1111" }</code></pre>

页面列表

ITEM_HTML