版本：202201
创建顾客
POST/openapi/2022-01/customers
使用提供的详情创建新顾客。
请求
- application/json
- 请求体
- 示例
请求体
- Array [
- ]
customer object
contact_typestring必填
Should be phone or email. If it's phone, the phone parameter is required, otherwise, the email parameter is required
emailstring
Email, it's required when contact_type is email, for example: [email protected]
phonestring
Phone number with area code, it's required when contact_type is phone, for example: +15052814445
first_namestring
First Name, for example: Peter
last_namestring
Last name, for example: Max
accepts_marketingboolean
Whether to subscribe marketing email campaign
默认值：
trueaccepts_sms_marketingboolean
Whether to subscribe marketing sms campaign.
默认值：
truepasswordstring
Password, for example: 123456
password_confirmationstring
Password confirmation, for example: 123456
tagsstring
Tags, for example: New Customer,Repeat Customer
registered_atstring必填
Customer registration time. If this field is empty, you cannot login. The time format is ISO8601, for example: 2024-03-11T03:32:00Z
addresses object[]
first_namestring必填
First name of consignee.
last_namestring必填
Last name of consignee.
emailstring
address1string
Street address, for example: 1 Rue des Carrieres
address2string
Apartment/floor/room number, for example: Suite 1234
areastring
Area, for example: Bay area
citystring
City, for example: SAN JOSE
provincestring
Province, for example: New Mexico
province_codestring
Province Code, for example: NM
countrystring必填
Country, for example: United States
country_codestring必填
Country code, for example: US
companystring
Company, for example: ABC Limited
phonestring
Phone number, for example: 5052814445
phone_area_codestring
Area code, for example: +86
zipstring
ZIP code, for example: 87036
genderstring
Gender, for example: male or female
defaultboolean
Default address or not
默认值：
true{
"customer": {
"contact_type": "string",
"email": "string",
"phone": "string",
"first_name": "string",
"last_name": "string",
"accepts_marketing": true,
"accepts_sms_marketing": true,
"password": "string",
"password_confirmation": "string",
"tags": "string",
"registered_at": "string",
"addresses": [
{
"first_name": "string",
"last_name": "string",
"email": "string",
"address1": "string",
"address2": "string",
"area": "string",
"city": "string",
"province": "string",
"province_code": "string",
"country": "string",
"country_code": "string",
"company": "string",
"phone": "string",
"phone_area_code": "string",
"zip": "string",
"gender": "string",
"default": true
}
]
}
}
响应
- 200
- 422
200
- application/json
- 数据结构
- 示例
- Result
数据结构
- Array [
- ]
customer object
idstring
示例：
2dd957e3-2051-4cdf-8584-9c0046b4d1aefirst_namestring
示例：
ryanlast_namestring
示例：
zhangnamestring
示例：
ryan zhangemailstring
phonestring
示例：
+8615014471143phone_area_code
contact_typestring
示例：
emailaccepts_marketingboolean
默认值：
true示例：
truesource
free_taxboolean
默认值：
true示例：
falseregisteredboolean
默认值：
true示例：
falseorders_countinteger
默认值：
0示例：
0last_order_at
total_spentstring
示例：
0.00tagsstring
示例：
New Customercreated_atstring
示例：
2024-04-17T11:10:33Zupdated_atstring
示例：
2024-04-17T11:10:33Zsubscribed_flaginteger
默认值：
0示例：
5sms_subscribed_flaginteger
默认值：
0示例：
5accepts_sms_marketingboolean
默认值：
true示例：
truedefault_address object
idstring
示例：
9ffa8dc0-25b8-4424-832e-bab46fcfeb20customer_idstring
示例：
2dd957e3-2051-4cdf-8584-9c0046b4d1aefirst_namestring
示例：
testlast_namestring
示例：
testcompanystring
示例：
citystring
示例：
深圳provincestring
示例：
countrystring
示例：
Aland lslandszipstring
示例：
515300province_codestring
示例：
country_codestring
示例：
AXgenderstring
示例：
phonestring
示例：
+86 150 1447 1143phone_area_code
areastring
示例：
emailstring
namestring
示例：
test testaddress1string
示例：
6 三聖街address2string
示例：
1111country_namestring
示例：
Aland lslandsdefaultboolean
默认值：
true示例：
trueaddresses object[]
idstring
示例：
9ffa8dc0-25b8-4424-832e-bab46fcfeb20customer_idstring
示例：
2dd957e3-2051-4cdf-8584-9c0046b4d1aefirst_namestring
示例：
testlast_namestring
示例：
testcompanystring
示例：
citystring
示例：
深圳provincestring
示例：
countrystring
示例：
Aland lslandszipstring
示例：
515300province_codestring
示例：
country_codestring
示例：
AXgenderstring
示例：
phonestring
示例：
+86 150 1447 1143phone_area_code
areastring
示例：
emailstring
namestring
示例：
test testaddress1string
示例：
6 三聖街address2string
示例：
1111country_namestring
示例：
Aland lslandsdefaultboolean
默认值：
true示例：
true{
"customer": {
"id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae",
"first_name": "ryan",
"last_name": "zhang",
"name": "ryan zhang",
"phone": "+8615014471143",
"phone_area_code": {},
"contact_type": "email",
"accepts_marketing": true,
"source": {},
"free_tax": false,
"registered": false,
"orders_count": 0,
"last_order_at": {},
"total_spent": "0.00",
"tags": "New Customer",
"created_at": "2024-04-17T11:10:33Z",
"updated_at": "2024-04-17T11:10:33Z",
"subscribed_flag": 5,
"sms_subscribed_flag": 5,
"accepts_sms_marketing": true,
"default_address": {
"id": "9ffa8dc0-25b8-4424-832e-bab46fcfeb20",
"customer_id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae",
"first_name": "test",
"last_name": "test",
"company": "",
"city": "深圳",
"province": "",
"country": "Aland lslands",
"zip": "515300",
"province_code": "",
"country_code": "AX",
"gender": "",
"phone": "+86 150 1447 1143",
"phone_area_code": {},
"area": "",
"name": "test test",
"address1": "6 三聖街",
"address2": "1111",
"country_name": "Aland lslands",
"default": true
},
"addresses": [
{
"id": "9ffa8dc0-25b8-4424-832e-bab46fcfeb20",
"customer_id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae",
"first_name": "test",
"last_name": "test",
"company": "",
"city": "深圳",
"province": "",
"country": "Aland lslands",
"zip": "515300",
"province_code": "",
"country_code": "AX",
"gender": "",
"phone": "+86 150 1447 1143",
"phone_area_code": {},
"area": "",
"name": "test test",
"address1": "6 三聖街",
"address2": "1111",
"country_name": "Aland lslands",
"default": true
}
]
}
}
{
"customer": {
"id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae",
"first_name": "ryan",
"last_name": "zhang",
"name": "ryan zhang",
"phone": "+8615014471143",
"phone_area_code": null,
"contact_type": "email",
"accepts_marketing": true,
"source": null,
"free_tax": false,
"registered": false,
"orders_count": 0,
"last_order_at": null,
"total_spent": "0.00",
"tags": "New Customer",
"created_at": "2024-04-17T11:10:33Z",
"updated_at": "2024-04-17T11:10:33Z",
"subscribed_flag": 5,
"sms_subscribed_flag": 5,
"accepts_sms_marketing": true,
"default_address": {
"id": "9ffa8dc0-25b8-4424-832e-bab46fcfeb20",
"customer_id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae",
"first_name": "test",
"last_name": "test",
"company": "",
"city": "深圳",
"province": "",
"country": "Aland lslands",
"zip": "515300",
"province_code": "",
"country_code": "AX",
"gender": "",
"phone": "+86 150 1447 1143",
"phone_area_code": null,
"area": "",
"name": "test test",
"address1": "6 三聖街",
"address2": "1111",
"country_name": "Aland lslands",
"default": true
},
"addresses": [
{
"id": "9ffa8dc0-25b8-4424-832e-bab46fcfeb20",
"customer_id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae",
"first_name": "test",
"last_name": "test",
"company": "",
"city": "深圳",
"province": "",
"country": "Aland lslands",
"zip": "515300",
"province_code": "",
"country_code": "AX",
"gender": "",
"phone": "+86 150 1447 1143",
"phone_area_code": null,
"area": "",
"name": "test test",
"address1": "6 三聖街",
"address2": "1111",
"country_name": "Aland lslands",
"default": true
}
]
}
}
422
- application/json
- 数据结构
- 示例
- Result
数据结构
errorsstring[]
{
"errors": [
"Email or Phone is already taken"
]
}
{
"errors": [
"Email or Phone is already taken",
"Password is too short (minimum is 6 characters)",
"Contact type is not included in the list",
"Password confirmation must be equal to password",
"Phone is invalid",
"Country can't be blank",
"Country code can't be blank"
]
}