版本：202201
查询顾客列表
GET/openapi/2022-01/customers
分页返回顾客列表。
请求
Query参数
ids string
ID 列表。
limit int32
Record count in every page, maximum: 250
默认值：
10page int32
Page number
默认值：
1created_at_min string
最早创建时间。
created_at_max string
最晚创建时间。
updated_at_min string
最早更新时间。
updated_at_max string
最晚更新时间。
email string
电子邮件地址。
contact string
联系方式类型。
响应
- 200
- 400
- 406
200
- application/json
- 数据结构
- 示例
- Result
数据结构
- Array [
- Array [
- ]
- ]
customers 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{
"customers": [
{
"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
}
]
}
]
}
{
"customers": [
{
"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
}
]
}
]
}
400
- application/json
- 数据结构
- 示例
- Result
数据结构
errorsstring[]
{
"errors": [
"Exceeds maximum limit of 250"
]
}
{
"errors": [
"Exceeds maximum limit of 250"
]
}
406
- application/json
- 数据结构
- 示例
- Result
数据结构
errorsstring[]
{
"errors": [
"Created at max time format error"
]
}
{
"errors": [
"Created at max time format error",
"Updated at min time format error",
"Updated at max time format error"
]
}