新增顾客信息

需要 write_customers 权限点。

更多权限点使用信息,请参考:

[]

访问权限

POST https://{handle}.myshopline.com/admin/openapi/v20250601/customers.json

[]

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

[]

在店铺中创建一个新客户。需要提供客户邮箱、手机号等详细信息。

请求头

Content-Type required
[]
字段值固定为application/json; charset=utf-8
Authorization string required
[]
资源的访问令牌。请参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

请求体

customerobject
[]
客户信息。
accepts_marketing boolean
[]
客户是否接受通过邮箱订阅营销信息，若修改订阅状态时客户邮箱为必填。

废弃：该字段自 API 版本 v20250601 起已废弃。
[]
Example: true
addressesobject[]
[]
客户地址列表。

最大个数限制：50
address1 string
[]
客户地址第一行，通常是街道地址或邮政信箱编号等信息。

最大长度限制：255
[]
Example: 7720 Cherokee Road
address2 string
[]
客户地址的第二行，通常是公寓、套房或单元等信息。

最大长度限制：255
[]
Example: Apartment 2
city string
[]
地址中的城市。

最大长度限制：64
[]
Example: Hagerman
company string
[]
客户所在的公司名称。

最大长度限制：255
[]
Example: Joy
country string
[]
地址出现中的国家或地区。

最大长度限制：64
[]
Example: United States
country_code string
[]
地址中出现的国家或地区码，遵循 ISO 3611-1(alpha 2) 国际标准的二位国家或区域码，用于识别市场所在的国家或地区。

例如 US。
[]
Example: US
country_name string
[]
地址中的标准化国家/地区名称。

废弃：该字段自 API 版本 v20250601 起已废弃。
[]
Example: United States
default boolean
[]
该地址是否被设置为默认地址。有效枚举值包含：

true：默认地址

false：非默认地址

默认值：false
[]
Example: true
first_name string
[]
客户名。

最大长度限制：128
[]
Example: Bob
last_name string
[]
客户姓。

最大长度限制：128
[]
Example: Norman
name string
[]
客户的昵称。

废弃：该字段自 API 版本 v20250601 起已废弃。
[]
Example: NormanBob
phone string
[]
客户的手机号码。

最大长度限制：20
[]
Example: 001467326483
province string
[]
地址中的省份。

最大长度限制：64
[]
Example: Kentucky
province_code string
[]
地址中省份的编码，该编码可以是自定义编号或者为二位的 ISO 3166-2 国际编码。
[]
Example: KY
zip string
[]
地址的邮编信息。

最大长度限制：10
[]
Example: 40202
birthday string
[]
客户出生日期。使用格式：yyyyMMdd。

例子：20210831
[]
Example: 19970102
email string
[]
客户的邮箱。

最大长度限制：50
[]
Example: gungcherny@gamil.com
email_marketing_consentobject
[]
邮件营销订阅信息。
consent_collected_from string
[]
订阅信息来源。

最大长度限制：50
consent_updated_at string
[]
订阅变更时间。格式：ISO 8601。

例子：2021-08-31T02:20:26+08:00
[]
Example: 2022-09-07T10:53:31+08:00
opt_in_level integer
[]
订阅方式。有效枚举值包含：

0 ：未知

1 ：直接订阅

2 ：二次确认订阅

默认值根据店铺是否勾选【营销内容订阅】而不同：

勾选订阅选项：默认值为 2。

未勾选订阅选项：默认值为 1。

[]
Example: 1
state integer
[]
邮箱订阅状态。有效枚举值包含：

0 ：取消订阅

1 ：已订阅

2 ：未订阅

3 ：订阅确认中

email_marketing_consent 下的其它任意子字段有传值时，该字段都必传。
[]
Example: 1
first_name string
[]
客户名。

最大长度限制：128
[]
Example: Bob
gender integer
[]
客户性别。有效枚举值包含：

0 ：未设置

1 ：男

2 ：女

3 ：保密/不公开

默认取值为 0
[]
Example: 1
last_name string
[]
客户姓。

最大长度限制：128
[]
Example: Norman
multipass_identifier string
[]
用于 Multipass 登录的客户的唯一标识符。

最大长度限制：100
note string
[]
商家对客户的备注。

最大长度限制：1000
[]
Example: Placed an order that had a fraud warning
password string
[]
客户的密码，若开发者传入则用户状态从待邀请变为已注册。客户的状态通过响应中的 customer.state 字段表示。仅支持大小写英文字母、数字和符号。

最小长度限制：6

最大长度限制：18
[]
Example: 31233
password_confirmation string
[]
再次输入客户密码，以保证和 password 输入一致。仅支持大小写英文字母、数字和符号。

最小长度限制：6

最大长度限制：18
[]
Example: 31233
phone string
[]
客户的手机号码。

最大长度限制：20
[]
Example: 001467326483
sms_marketing_consentobject
[]
短信营销订阅信息。
consent_collected_from string
[]
订阅信息来源。

最大长度限制：50
consent_updated_at string
[]
订阅变更时间。格式：ISO 8601。

例子：2021-08-31T02:20:26+08:00
[]
Example: 2022-09-07T10:53:31+08:00
opt_in_level integer
[]
订阅方式。有效枚举值包含：

0 ：未知

1 ：直接订阅

2 ：二次确认订阅

[]
Example: 1
state integer
[]
短信订阅状态。有效枚举值包含：

0 ：取消订阅

1 ：已订阅

2 ：未订阅

sms_marketing_consent 下的其它任意子字段有传值时，该字段都必传。
[]
Example: 1
tags string
[]
为客户添加标签，不同标签之间使用逗号分隔。

最大标签个数限制：100

单个标签长度限制：128

总字符串长度限制：1000
[]
Example: loyal
verified_email boolean
[]
邮箱是否已验证。有效枚举值包含：

true：已验证

false：未验证

默认取值为：false
[]
Example: true

响应

[]

更多状态码信息请参考 HTTP 状态码

响应头

traceId
[]
traceId

响应体

customerobject
[]
客户信息。
accepts_marketing boolean
[]
客户是否接受通过邮箱订阅营销信息，若修改订阅状态时客户邮箱为必填。

废弃：该字段自 API 版本 v20250601 起已废弃。
[]
Example: true
accepts_marketing_updated_at string
[]
客户更新订阅邮件营销的时间。

废弃：该字段自 API 版本 v20250601 起已废弃。
[]
Example: 2022-05-31T15:32:46+08:00
accepts_mobile_marketing boolean
[]
客户是否接受手机号订阅营销信息。

废弃：该字段自 API 版本 v20250601 起已废弃。
[]
Example: true
accepts_mobile_marketing_updated_at string
[]
客户更新订阅手机号营销的时间。

废弃：该字段自 API 版本 v20250601 起已废弃。
[]
Example: 2022-05-31T15:32:46+08:00
addressesobject[]
[]
客户地址列表。
address1 string
[]
客户地址第一行，通常是街道地址或邮政信箱编号等信息。
[]
Example: 7720 Cherokee Road
address2 string
[]
客户地址的第二行，通常是公寓、套房或单元等信息。
[]
Example: Apartment 2
city string
[]
地址中的城市。
[]
Example: Hagerman
company string
[]
客户所在的公司名称。
[]
Example: Joy
country string
[]
地址中的国家或地区。
[]
Example: United States
country_code string
[]
地址中国家的二位国家码或地区码，遵循 ISO 3611-1(alpha 2) 国际标准的二位国家或区域码，用于识别市场所在的国家或地区。
[]
Example: US
customer_id string
[]
客户的唯一标识符 ID。
[]
Example: 4201825054
default boolean
[]
该地址是否被设置为默认地址。有效枚举值包含：

true：默认地址

false：非默认地址

[]
Example: true
first_name string
[]
客户名。
[]
Example: Bob
id string
[]
地址的唯一标识符 ID。
[]
Example: 207119551
last_name string
[]
客户姓。
[]
Example: Norman
phone string
[]
客户的手机号码。
[]
Example: 001467326483
province string
[]
地址中的省份。
[]
Example: Kentucky
province_code string
[]
地址中省份的编码，该编码可以是自定义编号或者为二位的 ISO 3166-2 国际编码。

废弃：该字段自 API 版本 v20250601 起已废弃。
[]
Example: KY
province_code_v2 string
[]
地址中省份的编码，该编码可以是自定义编号或者为二位的 ISO 3166-2 国际编码。
[]
Example: KY
zip string
[]
地址的邮编信息。
[]
Example: 40202
asid string
[]
Facebook 登录后的唯一 ID。
[]
Example: 481007156599455
birthday string
[]
客户出生日期。
[]
Example: 19970102
created_at string
[]
创建客户的日期和时间。
[]
Example: 2022-09-07T10:53:31+08:00
currency string
[]
客户下单币种。该字段值为三位币种码，遵循 ISO 4217 标准。
[]
Example: USD
default_addressobject
[]
默认地址。
address1 string
[]
客户地址第一行，通常是街道地址或邮政信箱编号等信息。
[]
Example: 7720 Cherokee Road
address2 string
[]
客户地址的第二行。通常是公寓、套房或单元等信息。
[]
Example: Apartment 2
city string
[]
地址中的城市。
[]
Example: Hagerman
company string
[]
客户所在的公司名称。
[]
Example: Joy
country string
[]
地址出现中的国家或地区。
[]
Example: United States
country_code string
[]
地址中国家的二位国家码或地区码，遵循 ISO 3611-1(alpha 2) 国际标准。
[]
Example: US
customer_id string
[]
客户的唯一标识符 ID。
[]
Example: 4201825054
default boolean
[]
该地址是否被设置为默认地址。
[]
Example: true
first_name string
[]
客户名。
[]
Example: Bob
id string
[]
地址的唯一标识符 ID。
[]
Example: 207119551
last_name string
[]
客户姓。
[]
Example: Norman
phone string
[]
客户的手机号码。
[]
Example: 001467326483
province string
[]
地址中的省份。
[]
Example: Kentucky
province_code string
[]
地址中省份的编码，该编码可以是自定义编号或者为二位的 ISO 3166-2 国际编码。

废弃：该字段自 API 版本 v20250601 起已废弃。
[]
Example: KY
province_code_v2 string
[]
地址中省份的编码，该编码可以是自定义编号或者为二位的 ISO 3166-2 国际编码。
zip string
[]
地址的邮编信息。
[]
Example: 40202
email string
[]
客户邮箱。
[]
Example: gungcherny@gamil.com
email_marketing_consentobject
[]
邮件营销订阅信息。
consent_collected_from string
[]
订阅信息来源。
consent_updated_at string
[]
订阅变更时间。格式：ISO 8601。
[]
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
[]
客户邮箱最终的订阅状态。根据 email_marketing_consent 相关入参信息返回。有效枚举值包含：

0 ：取消订阅

1 ：已订阅

2 ：未订阅

[]
Example: 1
first_name string
[]
客户名。
[]
Example: Bob
gender string
[]
客户性别。有效枚举值包含：

0 ：未设置

1 ：男

2 ：女

3 ：保密/不公开

[]
Example: female
id string
[]
客户的唯一标识符 ID。
[]
Example: 4201825054
language string
[]
客户所用语言。
[]
Example: en
last_name string
[]
客户姓。
[]
Example: Norman
last_order_id string
[]
客户最近一笔订单 ID。
[]
Example: 2005473211984312275741
last_order_name string
[]
客户最近一笔自定义订单号。
[]
Example: #20269M
mobile_subscribe_flag integer
[]
客户手机号最终的订阅状态。根据 sms_marketing_consent 相关入参信息返回。有效枚举值包含：

0：取消订阅

1：已订阅

2：未订阅
multipass_identifier string
[]
用于 Multipass 登录的客户的唯一标识符。
note string
[]
商家对客户的备注。
[]
Example: Placed an order that had a fraud warning
orders_count long
[]
客户下单的订单数量。
[]
Example: 12
phone string
[]
客户的手机号码。
[]
Example: 001467326483
sms_marketing_consentobject
[]
短信营销订阅信息。
consent_collected_from string
[]
订阅信息来源。
consent_updated_at string
[]
订阅变更时间。格式：ISO 8601。
[]
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
social_customer array
[]
客户在社媒的唯一标识 ID。

废弃：该字段自 API 版本 v20250601 起已废弃。
[]
Example: [6612273988815231]
state integer
[]
客户状态。有效枚举值包含：

0：已禁用账户

1：待邀请账户

2：已邀请账户

3：已注册账户

[]
Example: 2
tags string
[]
客户的标签。
[]
Example: loyal
total_spent string
[]
客户总花费金额。
[]
Example: 100
updated_at string
[]
客户更新时间。格式：ISO 8601。
[]
Example: 2022-09-07T10:53:31+08:00
verified_email boolean
[]
邮箱是否已验证。有效枚举值包含：

true：已验证

false：未验证

API Explorer

调试台

示例代码

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "customer": {
    "accepts_marketing": true,
    "addresses": [
      {
        "address1": "7720 Cherokee Road",
        "address2": "Apartment 2",
        "city": "Hagerman",
        "company": "Joy",
        "country": "United States",
        "country_code": "US",
        "country_name": "United States",
        "default": true,
        "first_name": "Bob",
        "last_name": "Norman",
        "name": "NormanBob",
        "phone": "001467326483",
        "province": "Kentucky",
        "province_code": "KY",
        "zip": "40202"
      }
    ],
    "birthday": "19970102",
    "email": "gungcherny@gamil.com",
    "email_marketing_consent": {
      "consent_collected_from": "",
      "consent_updated_at": "2022-09-07T10:53:31+08:00",
      "opt_in_level": 1,
      "state": 1
    },
    "first_name": "Bob",
    "gender": 1,
    "last_name": "Norman",
    "multipass_identifier": "",
    "note": "Placed an order that had a fraud warning",
    "password": "31233",
    "password_confirmation": "31233",
    "phone": "001467326483",
    "sms_marketing_consent": {
      "consent_collected_from": "",
      "consent_updated_at": "2022-09-07T10:53:31+08:00",
      "opt_in_level": 1,
      "state": 1
    },
    "tags": "loyal",
    "verified_email": true
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/customers.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json' \
     --data '
{
  "customer": {
    "accepts_marketing": true,
    "addresses": [
      {
        "address1": "7720 Cherokee Road",
        "address2": "Apartment 2",
        "city": "Hagerman",
        "company": "Joy",
        "country": "United States",
        "country_code": "US",
        "country_name": "United States",
        "default": true,
        "first_name": "Bob",
        "last_name": "Norman",
        "name": "NormanBob",
        "phone": "001467326483",
        "province": "Kentucky",
        "province_code": "KY",
        "zip": "40202"
      }
    ],
    "birthday": "19970102",
    "email": "gungcherny@gamil.com",
    "email_marketing_consent": {
      "consent_collected_from": "",
      "consent_updated_at": "2022-09-07T10:53:31+08:00",
      "opt_in_level": 1,
      "state": 1
    },
    "first_name": "Bob",
    "gender": 1,
    "last_name": "Norman",
    "multipass_identifier": "",
    "note": "Placed an order that had a fraud warning",
    "password": "31233",
    "password_confirmation": "31233",
    "phone": "001467326483",
    "sms_marketing_consent": {
      "consent_collected_from": "",
      "consent_updated_at": "2022-09-07T10:53:31+08:00",
      "opt_in_level": 1,
      "state": 1
    },
    "tags": "loyal",
    "verified_email": true
  }
}
'

这篇文章对你有帮助吗？

SHOPLINE

条款协议

Error loading component.