客户信息检索

需要 read_customers 权限点。

更多权限点使用信息，请参考：

GET https://{handle}.myshopline.com/admin/openapi/v20260301/customers/v2/search.json

handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。

通过查询条件查询客户。可以通过指定的模糊查询条件：如客户邮箱、姓名模糊搜索客户；或者通过查询条件如客户订阅状态，查询客户信息。

查询参数

fields string

指明需要返回的字段，多个字段用逗号分隔。可指定的字段范围参考响应体中 customers 对象下的一级子字段。

例子: id,email,first_name
limit string

设置返回客户个数的最大数量。

返回客户个数限制：1-250

默认个数：50
order string
客户排序规则。
- 0：根据客户创建时间倒序排序。
- 1：根据客户创建时间倒序排序，若创建时间一致则按照最近一笔订单时间倒序排序。
- 2：根据客户创建时间倒序排序，若创建时间一致则按照支付订单量倒序排序。
- 3：根据客户创建时间倒序排序，若创建时间一致则按照客户ID倒序排序。
默认值：0
page_info string

分页查询的唯一标识，用于定位特定页面。

该字段值需要在你已经查询完分页信息后，在该接口响应头中的 link 字段值中获取。例如，你获取到的 link 的值为 <https://{handle}.myshopline.com/admin/openapi/{version}/customers/v2/search.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next" ，那么 page_info 的值为 eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9 。

关于更多如何使用分页信息，请参考分页机制。
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:2
query_param string

模糊查询条件。支持用以下字段条件进行查询：phone，email，first_name，last_name，address1，address2，各字段含义参考响应体。

最大长度限制：50

例子: bob

请求头

Content-Type string required

字段值固定为 application/json; charset=utf-8。
Authorization string required

资源的访问令牌。参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
例子:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

状态码

更多状态码信息，参考 HTTP 状态码。

响应头

link

提供分页数据的 URL 链接。你可以获取该字段值中的 page_info 信息用于下一次分页请求中。

当你请求的页面存在上一页或下一页的时候，该字段会被返回。关于更多如何使用分页信息，请参考分页机制。
traceId

请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。

响应体

customersobject[]

客户列表。
accepts_marketing boolean

客户是否接受通过邮箱订阅营销信息。

废弃：该字段自 API 版本 v20250601 起已废弃。
accepts_marketing_updated_at string

客户更新订阅邮件营销的时间。

废弃：该字段自 API 版本 v20250601 起已废弃。
accepts_mobile_marketing boolean

客户是否接受手机号订阅营销信息。

废弃：该字段自 API 版本 v20250601 起已废弃。
accepts_mobile_marketing_updated_at string

客户更新订阅手机号营销的时间。

废弃：该字段自 API 版本 v20250601 起已废弃。
addressesobject[]

客户地址列表。
address1 string

客户地址第一行，通常是街道地址或邮政信箱编号等信息。
例子: 7720 Cherokee Road
address2 string

客户地址的第二行，通常是公寓、套房或单元等信息。
例子: Apartment 2
city string

地址中的城市。
company string

客户所在的公司名称。
country string

地址中的国家或地区。
例子: United States
country_code string

地址中国家的二位国家码或地区码，遵循 ISO 3611-1 (alpha 2) 国际标准的二位国家或区域码，用于识别市场所在的国家或地区。
customer_id string

客户的唯一标识符 ID。
default boolean

该地址是否被设置为默认地址。有效枚举值包含：

true：默认地址

false：非默认地址

first_name string

客户名。
例子: Bob
id string

地址的唯一标识符 ID。
last_name string

客户姓。
例子: Norman
phone string

客户的手机号码。
例子: 001123-***-7890
province string

地址中的省份。
例子: Kentucky
province_code string

地址中省份的自定义编码。

废弃：该字段自 API 版本 v20250601 起已废弃。
province_code_v2 string

地址中省份的编码，该编码为二位的 ISO 3166-2 国际编码。
例子: KY
zip string

地址的邮编信息。
asid string

Facebook 登录后的唯一 ID。
birthday string

客户出生日期。使用格式：yyyyMMdd。
例子: 19970102
created_at string

创建客户的日期和时间。格式：ISO 8601。
例子: 2022-09-07T10:53:31+08:00
currency string

客户下单币种。该字段值为三位币种码，遵循 ISO 4217 标准。
例子: USD
default_addressobject

默认地址。
address1 string

客户地址第一行，通常是街道地址或邮政信箱编号等信息。
例子: 7720 Cherokee Road
address2 string

客户地址的第二行。通常是公寓、套房或单元等信息。
例子: Apartment 2
city string

地址中的城市。
例子: Hagerman
company string

客户所在的公司名称。
country string

地址出现中的国家或地区。
例子: United States
country_code string

地址中国家的二位国家码或地区码，遵循 ISO 3611-1 (alpha 2) 国际标准的二位国家或区域码，用于识别市场所在的国家或地区。
例子: US
customer_id string

客户的唯一标识符 ID。
default boolean

固定返回为 true，表示该地址被设置为默认地址。
first_name string

客户名。
例子: Bob
id string

地址的唯一标识符 ID。
last_name string

客户姓。
例子: Norman
phone string

客户的手机号码。
例子: 001123-***-7890
province string

地址中的省份。
例子: Kentucky
province_code string

地址中省份的自定义编码。

废弃：该字段自 API 版本 v20250601 起已废弃。
province_code_v2 string

地址中省份的编码，该编码为二位的 ISO 3166-2 国际编码。
例子: KY
zip string

地址的邮编信息。
例子: 40202
email string

客户邮箱。
例子: *********@example.com
email_marketing_consentobject

邮件营销订阅信息。
consent_collected_from string

订阅信息来源。
例子: Pop
consent_updated_at string

订阅变更的日期和时间。格式：ISO 8601。
opt_in_level integer

订阅方式。有效枚举值包含：

0 ：未知

1 ：直接订阅

2 ：二次确认订阅

state integer

邮箱订阅状态。有效枚举值包含：

0 ：取消订阅

1 ：已订阅

2 ：未订阅

3 ：订阅确认中
email_subscribe_flag integer

客户邮箱最终的订阅状态。根据创建或者更新客户时的 email_marketing_consent 相关入参信息返回。有效枚举值包含：

0 ：取消订阅

1 ：已订阅

2 ：未订阅
first_name string

客户名。
gender string

客户性别。有效枚举值包含：

0 ：未设置

1 ：男

2 ：女

3 ：保密/不公开
id string

客户的唯一标识符 ID。
language string

客户所用语言。
last_name string

客户姓。
例子: Norman
last_order_id string

客户最近一笔订单ID。
last_order_name string

客户最近一笔自定义订单号。
mobile_subscribe_flag integer

客户手机号最终的订阅状态。根据创建或者更新客户时的 sms_marketing_consent 相关入参信息返回。有效枚举值包含：

0：取消订阅

1：已订阅

2：未订阅
multipass_identifier string

用于 Multipass 登录的客户的唯一标识符。
nick_name string

客户昵称。
note string

商家对客户的备注。
orders_count long

客户下单的订单数量。
phone string

客户的手机号码。
例子: 001123-***-7890
sms_marketing_consentobject

短信营销订阅信息。
consent_collected_from string

订阅信息来源。
例子: Pop
consent_updated_at string

订阅变更的日期和时间。格式：ISO 8601。
例子: 2021-08-31T02:20:26+08:00
opt_in_level integer

订阅方式。有效枚举值包含：

0 ：未知

1 ：直接订阅

2 ：二次确认订阅

state integer

短信订阅状态。有效枚举值包含：

0 : 取消订阅

1 : 已订阅

2 : 未订阅

3 : 订阅确认中
social_customer array

客户在社媒的唯一标识 ID。

废弃：该字段自 API 版本 v20250601 起已废弃。
state integer

客户状态。有效枚举值包含：

0: 已禁用账户

1: 待邀请账户

2: 已邀请账户

3: 已注册账户
tags string

客户的标签。
total_spent string

客户总花费金额，以店铺币种展示。
updated_at string

客户更新的日期和时间。格式：ISO 8601。
例子: 2024-08-31T02:20:26+08:00
verified_email boolean

邮箱是否已验证。有效枚举值包含：

true：已验证

false：未验证

API Explorer

调试台

示例代码

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

Authorization — header required

fields — query

limit — query

order — query

page_info — query

query — query

query_param — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/customers/v2/search.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

这篇文章对你有帮助吗？

SHOPLINE

条款协议