顾客-列表
Customer Get Customer List API 文档
接口信息
- 接口地址:
{your-site-url}/api/skill/customer/get-customer-list
- 基础 URL:
{your-site-url} 需替换为你自己的独立站 URL 地址,如 https://your-domain.com/apimanager666
- 请求方式:
GET
- 说明: 此接口用于获取店铺的客户列表,支持多条件筛选和分页
认证
请求头中需要携带以下认证信息:
| Header |
值 |
说明 |
skill-access-token |
{your-skill-access-token} |
Skill API 访问令牌 |
请求参数 (Query String)
| 字段 |
类型 |
必填 |
说明 |
pageNum |
int |
选填 |
第几页,不填写则默认第 1 页 |
pageSize |
int |
选填 |
每页的数据个数,不填写则使用系统默认值 |
email |
string |
选填 |
客户邮箱,模糊搜索 |
customer_type |
int |
选填 |
客户类型。1 = 订阅用户,2 = 已购用户,3 = 复购用户,4 = 下载用户(下载 PDF 需留邮箱) |
accepts_marketing |
int |
选填 |
邮件订阅状态。1 = 接受营销邮件,2 = 拒绝营销邮件 |
created_at_begin |
string |
选填 |
账号创建时间区间 - 开始(大于),如 2026-05-01 00:00:00 |
created_at_end |
string |
选填 |
账号创建时间区间 - 结束(小于等于),如 2026-05-25 23:59:59 |
phone |
string |
选填 |
客户手机号码 |
country_code |
string |
选填 |
客户国家简码(如 US、CN) |
order_count_begin |
int |
选填 |
下单个数区间 - 开始(大于) |
order_count_end |
int |
选填 |
下单个数区间 - 结束(小于等于) |
order_amount_begin |
float |
选填 |
订单总额区间 - 开始金额(大于) |
order_amount_end |
float |
选填 |
订单总额区间 - 结束金额(小于等于) |
customervip_id |
int |
选填 |
会员等级 ID |
payafteruse_status |
int |
选填 |
先用后付状态。1 = 先用后付客户,2 = 非先用后付客户 |
请求示例
cURL
curl --location --request GET '{your-site-url}/api/skill/customer/get-customer-list' \
--header 'skill-access-token: {your-skill-access-token}' \
--data-raw ''
按邮箱搜索
curl --location --request GET '{your-site-url}/api/skill/customer/get-customer-list?email=fecify@126.com' \
--header 'skill-access-token: {your-skill-access-token}' \
--data-raw ''
按国家筛选
curl --location --request GET '{your-site-url}/api/skill/customer/get-customer-list?country_code=US&pageNum=1&pageSize=20' \
--header 'skill-access-token: {your-skill-access-token}' \
--data-raw ''
返回结果
code 为 200 表示调用成功;code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": {
"list": [
{
"id": 571,
"shop_id": 15,
"email": "3332232323@qq.com",
"first_name": "firstname",
"last_name": "lastname",
"status": 1,
"created_at": "2026-05-15 16:00:55",
"updated_at": "2026-05-15 16:03:04",
"phone": "",
"country_code": "US",
"area_name": "Washington",
"order_count": 0,
"order_amount": "0.00",
"note": "",
"register_type": 1,
"customervip_id": 0,
"payafteruse_status": null,
"payafteruse_level": null,
"country": {
"code": "US",
"cn_name": "美国",
"name": "United States"
}
}
],
"total": 485,
"pageSize": 20,
"totalPage": 25
},
"message": "success"
}
返回字段说明
| 字段 |
类型 |
说明 |
code |
Number |
状态码,200 表示成功 |
message |
String |
执行结果的文字描述 |
data |
Object |
返回数据 |
data 顶层字段
| 字段 |
类型 |
说明 |
total |
int |
客户总数 |
pageSize |
int |
每页的数据个数 |
totalPage |
int |
总页数 |
list |
Array[Object] |
客户列表 |
list 子项字段
| 字段 |
类型 |
说明 |
id |
int |
客户 ID |
shop_id |
int |
店铺 ID |
email |
string |
客户邮箱 |
register_type |
int |
注册方式。1 = 邮箱注册,2 = 手机号注册 |
first_name |
string |
名 |
last_name |
string |
姓 |
status |
int |
客户状态。1 = 激活状态,2 = 注册待激活,3 = 订阅待激活,4 = 下单创建待激活,5 = 后台创建待激活,6 = 下载文件待激活状态 |
created_at |
string |
创建时间 |
updated_at |
string |
更新时间 |
phone |
string |
手机号(客户最后一次下单的手机号) |
country_code |
string |
国家简码(客户第一次下单的国家) |
area_name |
string |
省份/城市名称(客户第一次下单的地区) |
order_count |
int |
订单数(购买次数,由脚本每小时计算) |
order_amount |
string |
累计下单金额(由脚本每小时计算) |
note |
string |
客户备注 |
customervip_id |
int |
会员等级 ID。0 表示无会员等级 |
payafteruse_status |
int/null |
先用后付状态。1 = 先用后付客户。null 表示未开通 |
payafteruse_level |
int/null |
先用后付额度等级。null 表示无等级 |
country |
Object/null |
国家信息对象。若客户无国家信息则为 null |
country 子字段
| 字段 |
类型 |
说明 |
code |
string |
国家简码(如 US、CN) |
cn_name |
string |
国家中文名称 |
name |
string |
国家英文名称 |
注意事项
- 此接口为 GET 请求,参数通过 Query String 传递
- 所有搜索参数均为选填,可任意组合进行筛选
email 支持模糊搜索
created_at_begin 为大于(不包含边界),created_at_end 为小于等于(包含边界),格式如 2026-05-01 00:00:00
order_count_begin/order_count_end 和 order_amount_begin/order_amount_end 同理
order_count 和 order_amount 为脚本定时计算所得,非实时数据