顾客信息检索
GET https://{handle}.myshopline.com/admin/openapi/v20250601/customers/v2/search.json
handle
:店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com
的店铺,其 handle
是 open001
。顾客信息检索v2
查询参数
- fields string限定返回的对象的字段Example:
id
- limit integer查询数量限制,默认50,不能超过250Example:
10
- order integer排序规则 默认按用户创建时间倒序排序(0:用户创建时间)
- page_info string加密后的请求参数,包括所有的查询条件参数,用于上一页、下一页,直接取该字段解析访问Example:
eyJxdWVyeVBhcmFtU3RyaW5nIjoie1wic2l6ZVwiOjUwLFwic29ydFwiOltcInVpZDpkZXNjXCJdLFwic3RvcmVJZFwiOlwiMTYzOTY0MDU4MTM0NlwiLFwidWlkXCI6XCIwXCIsXCJ1cGRhdGVUaW1lXCI6XCJcIn0iLCJzaW5jZUlkTGlzdCI6WyI0MjAxNzk5MTAzIl0sInBhZ2UiOjIsInNpemUiOjUwLCJpbml0U29ydCI6WyJ1aWQ6ZGVzYyJdLCJzb3J0IjpbInVpZDpkZXNjIl0sImRpcmVjdGlvbiI6Im5le
- query string查询条件,支持(accepts_marketing,email_subscribe_flag,customer_date,customer_first_name,customer_id,tags,orders_count,order_date,state,total_spent,updated_at,verified_email)不同的字段用分号;隔开,字段与字段值用冒号:隔开。例:customer_id:1;orders_count:2Example:
email_subscribe_flag:1
- query_param string模糊查询条件 搜索范围包括 手机号、邮箱、客户名、常用地址信息Example:
Bob
请求头
- Content-Type required字段值固定为
application/json; charset=utf-8
- Authorization string required资源的访问令牌。请参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入Example:
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
响应
- 200
- 401
- 429
更多状态码信息请参考 HTTP 状态码
响应头
link
包含上一页、下一页的请求参数traceId
traceId
响应体
customersobject[]
客户列表accepts_marketing boolean是否邮件订阅Example:true
accepts_marketing_updated_at string邮件订阅时间(格式见ISO8601)Example:2022-05-31T15:32:46+08:00
accepts_mobile_marketing boolean是否接受电话营销Example:true
accepts_mobile_marketing_updated_at string电话订阅时间(格式见ISO8601)Example:2022-05-31T15:32:46+08:00
addressesobject[]
地址信息列表address1 string地址1Example:7720 Cherokee Road
address2 string地址2Example:Apartment 2
city string城市Example:Hagerman
company string公司Example:joyy
country string国家Example:United States
country_code string国家编码Example:US
customer_id string客户idExample:4201825054
default boolean是否默认地址Example:true
first_name string名称Example:Bob
id string地址idExample:207119551
last_name string姓Example:Norman
phone string电话号码Example:008615834564475
province string省Example:Kentucky
province_code string省编码Example:KY
zip string邮政编码Example:40202
asid stringFB登录idExample:481007156599455
birthday string客户生日 格式为:YYYYMMDDExample:19970102
created_at string创建时间(格式见ISO8601)Example:2022-09-07T10:53:31+08:00
currency string币种Example:USD
default_addressobject
默认地址address1 string地址1Example:7720 Cherokee Road
address2 string地址2Example:Apartment 2
city string城市Example:Hagerman
company string公司Example:joyy
country string国家Example:United States
country_code string国家编码Example:US
customer_id string客户idExample:4201825054
default boolean是否默认地址Example:true
first_name string名称Example:Bob
id string地址idExample:207119551
last_name string姓Example:Norman
phone string电话号码Example:008615834564475
province string省Example:Kentucky
province_code string省编码Example:KY
zip string邮政编码Example:40202
email string邮箱Example:gungcherny@gamil.com
email_marketing_consentobject
邮件营销订阅信息consent_collected_from string订阅信息来源Example:pop
consent_updated_at string订阅变更时间Example:2022-09-07T10:53:31+08:00
opt_in_level integer订阅方式(0;1;2)Example:1
state integer订阅状态(0:取消订阅;1:已订阅;2:未订阅;3:订阅确认中)Example:1
email_subscribe_flag integer邮箱订阅状态 0:取消订阅,1:已订阅,2:未订阅Example:1
first_name string用户名Example:Bob
gender string性别:male / female / others/secretExample:female
id string客户idExample:4201825054
language string客户所用语言Example:en
last_name string姓Example:Norman
last_order_id string最近一笔订单号Example:2005473211984312275741
last_order_name string最近一笔自定义订单号号Example:#20279M
mobile_subscribe_flag integer手机订阅状态0:取消订阅,1:已订阅,2:未订阅multipass_identifier stringmultipass标记Example:multipassIdentifier
nick_name string昵称Example:BobNorman
note string备注Example:Placed an order that had a fraud warning
orders_count long订单数量Example:12
phone string手机号Example:008615834564475
sms_marketing_consentobject
短信营销订阅信息consent_collected_from string订阅信息来源Example:pop
consent_updated_at string订阅变更时间Example:2022-09-07T10:53:31+08:00
opt_in_level integer订阅方式(0;1;2)Example:1
state integer订阅状态(0:取消订阅;1:已订阅;2:未订阅)Example:1
social_customer array社媒用户idExample:[6612273988815231]
state integer客户状态【0 : 已禁用账户,1:待启用账户,2:已邀请账户,3:有效账户】Example:2
tags string客户标签Example:loyal
total_spent string总花费金额Example:100
updated_at string更新时间(格式见ISO8601)Example:2022-09-07T10:53:31+08:00
verified_email boolean是否验证邮件
API Explorer
调试台
这篇文章对你有帮助吗?
Error loading component.