查询客户详情

需要 read_customers 权限点。

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

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

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

通过客户 ID 查询客户详细信息。

路径参数

id string required

客户的唯一标识符 ID。

最大长度限制：64

例子：4211465524

查询参数

fields string

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

例子: id,email,first_name

请求头

Content-Type string required

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

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

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

状态码

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

响应头

traceId

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

响应体

customerobject

客户信息。
accepts_marketing boolean

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

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

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

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

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

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

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

废弃：该字段自 API 版本 v20250601 起已废弃。
例子: 2022-05-31T15:32:46+08:00
addressesobject[]

客户地址列表。
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。
例子: 4201825054
default boolean

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

true：默认地址

false：非默认地址

first_name string

客户名。
例子: Bob
id string

地址的唯一标识符 ID。
例子: 207119551
last_name string

客户姓。
例子: Norman
phone string

客户的手机号码。
province string

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

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

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

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

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

Facebook 登录后的唯一 ID。
例子: 481007156599455
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。
例子: 4201825054
default boolean

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

客户名。
例子: Bob
id string

地址的唯一标识符 ID。
例子: 207119551
last_name string

客户姓。
例子: Norman
phone string

客户的手机号码。
province string

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

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

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

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

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

客户邮箱。
email_marketing_consentobject

邮件营销订阅信息。
consent_collected_from string

订阅信息来源。
consent_updated_at string

订阅变更时间。格式：ISO 8601。
例子: 2022-09-07T10:53:31+08:00
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

客户名。
例子: Bob
gender string

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

unknown ：未设置

male ：男

female ：女

secret ：保密/不公开
id string

客户的唯一标识符 ID。
例子: 4201825054
language string

客户所用语言。
例子: en
last_name string

客户姓。
例子: Norman
last_order_id string

客户最近一笔订单 ID。
例子: 2005473211984312275741
last_order_name string

客户最近一笔自定义订单号。
例子: #20279M
mobile_subscribe_flag integer

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

0：取消订阅

1：已订阅

2：未订阅
multipass_identifier string

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

客户的昵称。
例子: BobNorman
note string

商家对客户的备注。
例子: Placed an order that had a fraud warning
orders_count long

客户下单的订单数量。
例子: 12
phone string

客户的手机号码。
例子: 0086139****1234
sms_marketing_consentobject

短信营销订阅信息。
consent_collected_from string

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

订阅变更时间。格式：ISO 8601。
例子: 2022-09-07T10:53:31+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

客户的标签。
例子: loyal
total_spent string

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

客户信息更新的日期和时间。格式：ISO 8601。
例子: 2022-09-07T10:53:31+08:00
verified_email boolean

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

true：已验证

false：未验证

API Explorer

调试台

示例代码

Base URL

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

ParamOptions

id — path required

Authorization — header required

fields — query

Language

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

这篇文章对你有帮助吗？

SHOPLINE

条款协议