调试工具保证金授权店铺类型说明
youzan.mei.customer.search.4.0.0
不计费
2024-07-24 05:09:02

API名称:[连锁4.0] 搜索会员
API描述
API描述
[连锁4.0] 获取会员列表,支持按照手机号,会员编号搜索

公共参数
参数名称参数类型必须参数说明示例值
access_tokenString
鉴权凭证,用于请求API详见如何获取access_token
9b510e232c9e3716b4c1e264fe04cdc6
请求地址
请求参数

全部展开全部收起

参数名称
参数类型
必须
参数说明
示例值
page_size
java.lang.Integer
分页大小,默认20,最大值为200
20
page_no
java.lang.Integer
页数,默认1
1
node_kdt_id
java.lang.Long
该值不传表示在所有门店范围内搜索,传值代表在node_kdt_id门店下搜索
88888
force_from_db
java.lang.Boolean
是否强制从数据库查询true:是 false:从es查询,默认false
true
start_create_at
java.lang.Long
成为客户的开始时间,单位毫秒
1672502400000
end_create_at
java.lang.Long
成为客户的结束时间,单位毫秒
1677600000000
keyword
java.lang.String
同时支持会员编号及手机号搜索
15227014566
返回参数

全部展开全部收起

参数名称
参数类型
参数说明
示例值
items
java.util.List
对象
member_created_at
java.lang.Long
成为会员时间
1558416863000
updated_at
java.util.Date
最后修改时间
1558416863000
belong_shop_name
java.lang.String
店铺名称
美德基
member_level_alias
java.lang.String
会员等级别名
dydj23Cdsmm
customer_gender
java.lang.Integer
性别GenderTypeEnum0其他1男2女
2
customer_growth
java.lang.Long
顾客成长值
2
member_level_name
java.lang.String
会员等级名称
普通会员
customer_mobile
java.lang.String
顾客手机号
18688233212
customer_name
java.lang.String
用户姓名
joken
avatar
java.lang.String
用户头像
http://wx.qlogo.cn/mmopen/2EeibkTp2yCFoXKGeoteUoQz8vuico34G7ribCuEWsXsibpbcLxJxwmy8yr4ZIkREsibq4k6z94TBLUSbDrxWRE1SP7IcQf7O6a8X/132
source_name
java.lang.String
顾客来源名称
无来源
customer_no
java.lang.String
顾客编号
234523
member_level
java.lang.Integer
会员等级id
4
wechat_account
java.lang.String
顾客微信号
eporn_ke
source_id
java.lang.Long
顾客来源ID
0
belong_kdt_id
java.lang.Long
店铺名称
23523
customer_nike_name
java.lang.String
用户昵称(C端显示名称)
jok
yz_open_id
java.lang.String
有赞用户id,用户在有赞的唯一id
23524gtbfdb
customer_birth_day
java.lang.String
用户生日例如1989-12-21
1993-02-01
wechat_nick_name
java.lang.String
顾客微信昵称
ivy
customer_remark_name
java.lang.String
用户备注名
joken
created_at
java.util.Date
创建时间
1558416863000
is_member
java.lang.Integer
是否是会员0:非会员1:会员
1
code
int
200
200
paginator
object
分页参数
total_count
int
总数
10202
page
int
当前页
1
page_size
int
页大小
20
message
java.lang.String
success
success
success
boolean
true
true
请求示例
<?php
require_once './vendor/autoload.php';

$accessToken = 'YOUR_TOKEN';
$client = new \Youzan\Open\Client($accessToken);

$method = 'youzan.mei.customer.search';
$apiVersion = '4.0.0';

//设置参数
$params =[
	"node_kdt_id"=>59102134,
	"force_from_db"=>true,
	"page_no"=>34,
	"page_size"=>100
];

$response = $client->post($method, $apiVersion, $params);
var_dump($response);
?>
响应示例
{
  "trace_id": "yz7-0ae80913-1721798118452-569649",
  "code": 200,
  "success": true,
  "paginator": {
    "total_count": 6637,
    "page": 650,
    "page_size": 10
  },
  "message": "successful",
  "items": [
    {
      "customer_mobile": "18729903081",
      "customer_no": "A10275",
      "is_member": 1,
      "created_at": 1721751656000,
      "yz_open_id": "Pb1i6SJh888356180261404672",
      "wechat_account": "",
      "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/WqWfqT5yo8tmMhV7Nr5acVKkg0letP2uo4Pf2ic2pcEKpHW03kK7QusQVia1licicZRTXxsBt03VAIQ24sUQQricwqg/132",
      "member_created_at": 1721751656000,
      "member_level": 1,
      "wechat_nick_name": "",
      "belong_shop_name": "总部",
      "member_level_alias": "fuw336h5qls0wf",
      "belong_kdt_id": 1,
      "customer_remark_name": "",
      "updated_at": 1721751656000,
      "source_id": 0,
      "customer_name": "飘洋过海不回头,🏂",
      "customer_nike_name": "飘洋过海不回头,🏂",
      "customer_growth": 0,
      "customer_gender": 0,
      "source_name": "无来源",
      "member_level_name": "基础会员卡"
    },
    {
      "customer_mobile": "18734295021",
      "customer_no": "A10276",
      "is_member": 1,
      "created_at": 1721751656000,
      "yz_open_id": "2BMOC2zk1176144661668974592",
      "wechat_account": "",
      "avatar": "https://img.yzcdn.cn/upload_files/2020/08/04/Fj1Bufd7kfFGdybb8P4Irqnc1RUv.png",
      "member_created_at": 1721751656000,
      "member_level": 1,
      "wechat_nick_name": "",
      "belong_shop_name": "总部",
      "member_level_alias": "fuw336h5qls0wf",
      "belong_kdt_id": 1,
      "customer_remark_name": "",
      "updated_at": 1721751656000,
      "source_id": 0,
      "customer_name": "匿名用户",
      "customer_nike_name": "匿名用户",
      "customer_growth": 0,
      "customer_gender": 0,
      "source_name": "无来源",
      "member_level_name": "基础会员卡"
    },
    {
      "customer_mobile": "18755404559",
      "customer_no": "A10277",
      "is_member": 1,
      "created_at": 1721751656000,
      "yz_open_id": "aXKFI12U789579828637507584",
      "wechat_account": "",
      "avatar": "http://thirdwx.qlogo.cn/mmopen/mOW261WJzibsE188hE2cEeNe0WSw2m1JtHlvXJjslD4VkP2n4AljzR0ezoMYRPPq3zy9MkZyT3oQDkTQSpTKfHQ/132",
      "member_created_at": 1721751656000,
      "member_level": 1,
      "wechat_nick_name": "",
      "belong_shop_name": "总部",
      "member_level_alias": "fuw336h5qls0wf",
      "belong_kdt_id": 1,
      "customer_remark_name": "",
      "updated_at": 1721751656000,
      "source_id": 0,
      "customer_name": "盲鱼",
      "customer_nike_name": "盲鱼",
      "customer_growth": 0,
      "customer_gender": 0,
      "source_name": "无来源",
      "member_level_name": "基础会员卡"
    },
    {
      "customer_mobile": "18762987861",
      "customer_no": "A10278",
      "is_member": 1,
      "created_at": 1721751656000,
      "yz_open_id": "sqwwxIhX1254792444935995392",
      "wechat_account": "",
      "avatar": "https://img.yzcdn.cn/upload_files/2020/08/04/Fj1Bufd7kfFGdybb8P4Irqnc1RUv.png",
      "member_created_at": 1721751656000,
      "member_level": 1,
      "wechat_nick_name": "",
      "belong_shop_name": "总部",
      "member_level_alias": "fuw336h5qls0wf",
      "belong_kdt_id": 1,
      "customer_remark_name": "",
      "updated_at": 1721751656000,
      "source_id": 0,
      "customer_name": "匿名用户",
      "customer_nike_name": "匿名用户",
      "customer_growth": 0,
      "customer_gender": 0,
      "source_name": "无来源",
      "member_level_name": "基础会员卡"
    },
    {
      "customer_mobile": "18771249127",
      "customer_no": "A10279",
      "is_member": 1,
      "created_at": 1721751656000,
      "yz_open_id": "rTwVCQjb1225461493105995776",
      "wechat_account": "",
      "avatar": "https://img.yzcdn.cn/upload_files/2020/08/04/Fj1Bufd7kfFGdybb8P4Irqnc1RUv.png",
      "member_created_at": 1721751656000,
      "member_level": 1,
      "wechat_nick_name": "",
      "belong_shop_name": "总部",
      "member_level_alias": "fuw336h5qls0wf",
      "belong_kdt_id": 1,
      "customer_remark_name": "",
      "updated_at": 1721751656000,
      "source_id": 0,
      "customer_name": "匿名用户",
      "customer_nike_name": "匿名用户",
      "customer_growth": 0,
      "customer_gender": 0,
      "source_name": "无来源",
      "member_level_name": "基础会员卡"
    },
    {
      "customer_mobile": "18777353603",
      "customer_no": "A10280",
      "is_member": 1,
      "created_at": 1721751656000,
      "yz_open_id": "7Oi8jdij906542489903648768",
      "wechat_account": "",
      "avatar": "http://thirdwx.qlogo.cn/mmopen/C27GEeGiaPVFcXScGT282Xia9abGRzvrUWicLib8sjiaib2EmG4QE0nPrP5KLeibicsL4wKSBXLLZsiawsL8r6esnicVBDA3btveAINHg7/132",
      "member_created_at": 1721751656000,
      "member_level": 1,
      "wechat_nick_name": "",
      "belong_shop_name": "总部",
      "member_level_alias": "fuw336h5qls0wf",
      "belong_kdt_id": 1,
      "customer_remark_name": "",
      "updated_at": 1721751656000,
      "source_id": 0,
      "customer_name": "七秒",
      "customer_nike_name": "七秒",
      "customer_growth": 0,
      "customer_gender": 0,
      "source_name": "无来源",
      "member_level_name": "基础会员卡"
    },
    {
      "customer_mobile": "18785572959",
      "customer_no": "A10281",
      "is_member": 1,
      "created_at": 1721751656000,
      "yz_open_id": "nZDqojPO1073947671695241216",
      "wechat_account": "",
      "avatar": "http://wx.qlogo.cn/mmopen/05fUWyKHEukCicGVYAdc50AtKZmYoqfB9sr4RdmPhviaR707IGtlZ3GCDliblf6FXFX6bhnwLI1YZrf8Kk93HkB9exXHESJHMq9/132",
      "member_created_at": 1721751656000,
      "member_level": 1,
      "wechat_nick_name": "",
      "belong_shop_name": "总部",
      "member_level_alias": "fuw336h5qls0wf",
      "belong_kdt_id": 1,
      "customer_remark_name": "",
      "updated_at": 1721751656000,
      "source_id": 0,
      "customer_name": "陶…陶",
      "customer_nike_name": "陶…陶",
      "customer_growth": 0,
      "customer_gender": 0,
      "source_name": "无来源",
      "member_level_name": "基础会员卡"
    },
    {
      "customer_mobile": "18789173614",
      "customer_no": "A10282",
      "is_member": 1,
      "created_at": 1721751656000,
      "yz_open_id": "xZIO2HvU860505575711047680",
      "wechat_account": "",
      "avatar": "http://thirdwx.qlogo.cn/mmopen/KbnWyv6qsXOAlTicC9V2nRxS6vbWKibqjAbkib55NCkh4R0TAVQWyTHZ2AGnDzIqy0UzneUDfA99j2t0hvtuK7n0oVZQgGarjqb/132",
      "member_created_at": 1721751656000,
      "member_level": 1,
      "wechat_nick_name": "",
      "belong_shop_name": "总部",
      "member_level_alias": "fuw336h5qls0wf",
      "belong_kdt_id": 1,
      "customer_remark_name": "",
      "updated_at": 1721751656000,
      "source_id": 0,
      "customer_name": "柠檬🍋",
      "customer_nike_name": "柠檬🍋",
      "customer_growth": 0,
      "customer_gender": 0,
      "source_name": "无来源",
      "member_level_name": "基础会员卡"
    },
    {
      "customer_mobile": "18778510730",
      "customer_no": "A10283",
      "is_member": 1,
      "created_at": 1721751656000,
      "yz_open_id": "llAIpYp2951760042288254976",
      "wechat_account": "",
      "avatar": "https://img.yzcdn.cn/upload_files/2020/08/04/Fj1Bufd7kfFGdybb8P4Irqnc1RUv.png",
      "member_created_at": 1721751656000,
      "member_level": 1,
      "wechat_nick_name": "",
      "belong_shop_name": "总部",
      "member_level_alias": "fuw336h5qls0wf",
      "belong_kdt_id": 1,
      "customer_remark_name": "",
      "updated_at": 1721751656000,
      "source_id": 0,
      "customer_name": "匿名用户",
      "customer_nike_name": "匿名用户",
      "customer_growth": 0,
      "customer_gender": 0,
      "source_name": "无来源",
      "member_level_name": "基础会员卡"
    },
    {
      "customer_mobile": "18795755326",
      "customer_no": "A10284",
      "is_member": 1,
      "created_at": 1721751656000,
      "yz_open_id": "1w1ZEgXA1258096262415208449",
      "wechat_account": "",
      "avatar": "https://img.yzcdn.cn/upload_files/2020/08/04/Fj1Bufd7kfFGdybb8P4Irqnc1RUv.png",
      "member_created_at": 1721751656000,
      "member_level": 1,
      "wechat_nick_name": "",
      "belong_shop_name": "总部",
      "member_level_alias": "fuw336h5qls0wf",
      "belong_kdt_id": 1,
      "customer_remark_name": "",
      "updated_at": 1721751656000,
      "source_id": 0,
      "customer_name": "匿名用户",
      "customer_nike_name": "匿名用户",
      "customer_growth": 0,
      "customer_gender": 0,
      "source_name": "无来源",
      "member_level_name": "基础会员卡"
    }
  ]
}
异常示例
{
  "trace_id": "bifrost-gateway-0ae82d65-2562576186-17238b8f",
  "code": 230100003,
  "success": false,
  "message": "参数错误",
  "items": []
}
返回码
返回码描述解决方案
200请求成功
请求成功
如何获得此API权限
拥有此API的能力包拥有此API的能力包分类可获得此API能力包的应用类目
美业客户管理有赞美业客户关系CRM门店POSiPaaS数据集成有赞美业系统打通(连接器)

此篇文档是否对你有帮助?
文档反馈