GET 查询客户列表
接口地址 /bee/api/v1/customers
请求方式 GET
请求参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
page | 页码 | query | false | integer | |
pageSize | 每页条数 (默认每页返回50记录) | query | false | integer |
响应状态
状态码 | 说明 | schema |
---|---|---|
200 | OK | ResponseData |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
响应参数
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | 响应状态码 | integer(int32) | integer(int32) |
data | 通用返回数据 | object | |
message | 状态描述信息 | string | |
success | 是否成功 | boolean |
响应示例
{
"code": 200,
"data": [
{
"id": "1590403923849282800",
"customerName": "北京阅丰科技有限公司",
"customerCode": "91110108MA7H9PF91Y",
"status": "生效",
"keyContact": {
"name": "Michael",
"title": "项目经理",
"phoneNumber": "13533333333",
"eamilAddress": "michael.zhou@gmail.com"
},
"salesResp": "Ella",
"salesRespPhone": "13522222222",
"commissionRate": 0.5,
"crmId": "35d03rf9e0-30938id0309242",
"category": "大客户",
"province": "北京",
"city": "北京",
"region": "海淀区",
"address": "北京市海淀区八里庄路62号院1号楼10层1124号",
"note": "北京阅丰科技有限公司成立于2022年02月22日,注册地位于北京市海淀区八里庄路62号院1号楼10层1124号,法定代表人为毛炜",
"contacts": [
{
"id": "159048394853736260",
"name": "Michael",
"title": "项目经理",
"phoneNumber": "13533333333",
"emailAddress": "michael.zhou@gmail.com",
"createdBy": "Ella",
"createdOn": "2022-08-01 18:43:25",
"lastUpdatedBy": "Michael",
"lastUpdatedOn": "2022-08-10 13:22:12"
}
],
"createdBy": "Ella",
"createdOn": "2022-08-01 18:43:25",
"lastUpdatedBy": "Michael",
"lastUpdatedOn": "2022-08-10 13:22:12"
}
],
"message": "请求成功",
"success": true
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
POST 创建客户
接口地址 /bee/api/v1/customers
请求方式 POST
请求参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
createCustomerVo | 创建客户对象 | body | true | 创建客户对象 | 创建客户对象 |
创建客户对象
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
customerName | 客户名称 (长度:100,必填且唯一 ) | body | true | string(100) | |
category | 客户分类 | body | false | string(100) | |
crmId | 对外crmId (长度:100) | body | false | string(100) | |
commissionRate | 返佣比例 (输入0.5,表示50%) | body | false | number | |
customerCode | 社会信用代码 (长度:100,唯一 ) | body | false | string(100) | |
address | 快递地址 (长度:200 ) | body | false | string(200) | |
keyContact | 负责人信息 | body | true | 负责人信息 | 负责人信息 |
note | 备注信息 (长度:500 ) | body | false | string(500) | |
salesResp | 客户经理名称 (长度:100 ) | body | false | string(20) | |
salesRespPhone | 客户经理手机号 (长度:11 ) | body | true | string(20) |
负责人信息
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
name | 负责人名称 (长度:100 ) | body | true | string(100) | |
phoneNumber | 负责人手机号 (长度:11 ) | body | true | string(20) | |
emailAddress | 负责人邮箱 (长度:100 ) | body | false | string(100) | |
title | 负责人职位 (长度:100 ) | body | false | string(20) |
请求示例
{
"customerName": "北京阅丰科技有限公司",
"customerCode": "91110108MA7H9PF91Y",
"salesResp": "Ella",
"salesRespPhone": "135222222",
"commissionRate": 0.5,
"keyContact": {
"name": "Michael",
"title": "项目经理",
"phoneNumber": "13533333333",
"emailAddress": "michael.zhou@gmail.com"
},
"crmId": "xire--wred9e4303jdo0er3e",
"category": 0 ,
"address": "北京市海淀区八里庄路62号院1号楼10层1124号",
"note": "北京阅丰科技有限公司成立于2022年02月22日,注册地位于北京市海淀区八里庄路62号院1号楼10层1124号,法定代表人为毛炜。"
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
响应状态
状态码 | 说明 | schema |
---|---|---|
200 | OK | ResponseData«客户对象» |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
响应参数
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | 响应状态码 | integer(int32) | integer(int32) |
data | 通用返回数据 | 客户对象 | 客户对象 |
message | 状态描述信息 | string | |
success | 是否成功 | boolean |
客户对象
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
address | 快递地址 | string | |
category | 客户分类 | string | |
createdBy | 创建人 | string | |
createdOn | 创建时间 | string | |
crmId | 对外crmId | string | |
commissionRate | 返佣比例(0.5表示50%) | number | |
customerCode | 统一社会信用代码 | string | |
customerName | 客户名称 | string | |
id | id | integer(int64) | |
keyContact | 负责人信息 | 负责人信息 | 负责人信息 |
note | 备注信息 | string | |
province | 省 | string | |
city | 市 | string | |
region | 区 | string | |
salesResp | 客户经理名称 | string | |
salesRespPhone | 客户经理手机号 | string | |
status | 状态 | string |
负责人信息
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
emailAddress | 负责人邮箱 | string | |
name | 负责人名称 | string | |
phoneNumber | 负责人手机号 | string | |
title | 负责人职位 | string |
响应示例
{
"code": 0,
"data": {
"id": "1590403923849282800",
"customerName": "北京阅丰科技有限公司",
"customerCode": "91110108MA7H9PF91Y",
"status": "生效",
"keyContact": {
"name": "Michael",
"title": "项目经理",
"phoneNumber": "13533333333",
"eamilAddress": "michael.zhou@gmail.com"
},
"salesResp": "Ella",
"salesRespPhone": "13522222222",
"crmId": "35d03rf9e0-30938id0309242",
"commissionRate": 0.5,
"category": "大客户",
"province": "北京",
"city": "北京",
"region": "海淀区",
"address": "北京市海淀区八里庄路62号院1号楼10层1124号",
"note": "北京阅丰科技有限公司成立于2022年02月22日,注册地位于北京市海淀区八里庄路62号院1号楼10层1124号,法定代表人为毛炜",
"contacts": [
{
"id": "159048394853736260",
"name": "Michael",
"title": "项目经理",
"phoneNumber": "13533333333",
"emailAddress": "michael.zhou@gmail.com",
"createdBy": "Ella",
"createdOn": "2022-08-01 18:43:25",
"lastUpdatedBy": "Michael",
"lastUpdatedOn": "2022-08-10 13:22:12"
}
],
"createdBy": "Ella",
"createdOn": "2022-08-01 18:43:25",
"lastUpdatedBy": "Michael",
"lastUpdatedOn": "2022-08-10 13:22:12"
}
"message": "",
"success": true
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
PUT 更新客户
接口地址 /bee/api/v1/customers/{customer-id}
请求参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
updateCustomerVo | 客户对象 | body | true | 客户对象 | 客户对象 |
customer-id | customer-id | path | true | integer |
客户对象
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
customerName | 客户名称 (长度:100,必填且唯一 ) | body | true | string(100) | |
category | 客户分类 | body | false | string(100) | |
crmId | 对外crmId (长度:100) | body | false | string(100) | |
commissionRate | 返佣比例(0.5表示50%) | body | false | number | |
customerCode | 社会信用代码 (长度:100,唯一 ) | body | false | string(100) | |
address | 快递地址 (长度:200 ) | body | false | string(200) | |
keyContact | 负责人信息 | body | false | 负责人信息 | 负责人信息 |
note | 备注信息 (长度:500 ) | body | false | string(500) | |
salesResp | 客户经理名称 (长度:100 ) | body | false | string(20) | |
salesRespPhone | 客户经理手机号 (长度:11 ) | body | true | string(20) |
负责人信息
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
name | 负责人名称 (长度:100 ) | body | true | string(100) | |
phoneNumber | 负责人手机号 (长度:11 ) | body | true | string(20) | |
emailAddress | 负责人邮箱 (长度:100 ) | body | false | string(100) | |
title | 负责人职位 (长度:100 ) | body | false | string(20) |
请求示例
{
"customerName": "北京阅丰科技有限公司2",
"customerCode": "91110108MA7H9PF91Z",
"salesResp": "Ella",
"salesRespPhone": "135222222",
"keyContact": {
"name": "Michael",
"title": "项目经理",
"phoneNumber": "13533333333",
"emailAddress": "michael.zhou@gmail.com"
},
"crmId": "xire--wred9e4303jdo0er3e",
"commissionRate": 0.5,
"category": 0 ,
"address": "北京市海淀区八里庄路62号院1号楼10层1124号",
"note": "北京阅丰科技有限公司成立于2022年02月22日,注册地位于北京市海淀区八里庄路62号院1号楼10层1124号,法定代表人为毛炜。"
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
响应状态
状态码 | 说明 | schema |
---|---|---|
200 | OK | ResponseData«CustomerVo» |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
响应参数
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | 响应状态码 | integer(int32) | integer(int32) |
data | 通用返回数据 | SelectCustomerReturnVo | SelectCustomerReturnVo |
message | 状态描述信息 | string | |
success | 是否成功 | boolean |
客户对象
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
address | 快递地址 | string | |
category | 客户分类 | string | |
contacts | 联系人 | array | 负责人信息 |
createdBy | 创建人 | string | |
createdOn | 创建时间 | string | |
crmId | 对外crmId | string | |
customerCode | 统一社会信用代码 | string | |
customerName | 客户名称 | string | |
id | id | integer(int64) | |
keyContact | 负责人信息 | 负责人信息 | 负责人信息 |
lastUpdatedBy | 修改人 | string | |
lastUpdatedOn | 修改时间 | string | |
note | 备注信息 | string | |
salesResp | 客户经理名称 | string | |
salesRespPhone | 客户经理手机号 | string | |
status | 状态 | string |
负责人信息
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
createdBy | 创建人 | string | |
createdOn | 创建时间 | string | |
emailAddress | 负责人邮箱 | string | |
lastUpdatedBy | 修改人 | string | |
lastUpdatedOn | 修改时间 | string | |
name | 负责人名称 | string | |
phoneNumber | 负责人手机号 | string | |
title | 负责人职位 | string |
响应示例
{
"code": 0,
"data": {
"id": "1590403923849282800",
"customerName": "北京阅丰科技有限公司",
"customerCode": "91110108MA7H9PF91Y",
"status": "生效",
"keyContact": {
"name": "Michael",
"title": "项目经理",
"phoneNumber": "13533333333",
"eamilAddress": "michael.zhou@gmail.com"
},
"salesResp": "Ella",
"salesRespPhone": "13522222222",
"crmId": "35d03rf9e0-30938id0309242",
"category": "大客户",
"province": "北京",
"city": "北京",
"region": "海淀区",
"address": "北京市海淀区八里庄路62号院1号楼10层1124号",
"note": "北京阅丰科技有限公司成立于2022年02月22日,注册地位于北京市海淀区八里庄路62号院1号楼10层1124号,法定代表人为毛炜",
"contacts": [
{
"id": "159048394853736260",
"name": "Michael",
"title": "项目经理",
"phoneNumber": "13533333333",
"emailAddress": "michael.zhou@gmail.com",
"createdBy": "Ella",
"createdOn": "2022-08-01 18:43:25",
"lastUpdatedBy": "Michael",
"lastUpdatedOn": "2022-08-10 13:22:12"
}
],
"createdBy": "Ella",
"createdOn": "2022-08-01 18:43:25",
"lastUpdatedBy": "Michael",
"lastUpdatedOn": "2022-08-10 13:22:12"
}
"message": "",
"success": true
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
GET 查询客户
接口地址 /bee/api/v1/customers/{customer-id}
请求方式 GET
请求参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
customer-id | id/crmId | path | true | string |
响应状态
状态码 | 说明 | schema |
---|---|---|
200 | OK | ResponseData«SelectCustomerReturnVo» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
响应参数
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | 响应状态码 | integer(int32) | integer(int32) |
data | 通用返回数据 | SelectCustomerReturnVo | SelectCustomerReturnVo |
message | 状态描述信息 | string | |
success | 是否成功 | boolean |
schema属性说明
SelectCustomerReturnVo
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
address | 快递地址 | string | |
category | 客户分类 | string | |
city | 市 | string | |
commissionRate | 佣金率 | number | |
contacts | 联系人 | array | 负责人信息 |
createdBy | 创建人 | string | |
createdOn | 创建时间 | string | |
crmId | 对外crmId | string | |
customerCode | 统一社会信用代码 | string | |
customerName | 客户名称 | string | |
id | id | integer(int64) | |
keyContact | 负责人信息 | 负责人信息 | 负责人信息 |
lastUpdatedBy | 修改人 | string | |
lastUpdatedOn | 修改时间 | string | |
note | 备注信息 | string | |
province | 省 | string | |
region | 区 | string | |
salesResp | 客户经理名称 | string | |
salesRespPhone | 客户经理手机号 | string | |
status | 状态 | string |
负责人信息
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
createdBy | 创建人 | string | |
createdOn | 创建时间 | string | |
emailAddress | 负责人邮箱 | string | |
lastUpdatedBy | 修改人 | string | |
lastUpdatedOn | 修改时间 | string | |
name | 负责人名称 | string | |
phoneNumber | 负责人手机号 | string | |
title | 负责人职位 | string |
响应示例
{
"code": 200,
"data": {
"id": "1590403923849282800",
"customerName": "北京阅丰科技有限公司",
"customerCode": "91110108MA7H9PF91Y",
"status": "生效",
"keyContact": {
"id": "159048394853736260",
"name": "Michael",
"title": "项目经理",
"phoneNumber": "13533333333",
"eamilAddress": "michael.zhou@gmail.com",
"createdBy": "Ella",
"createdOn": "2022-08-01 18:43:25",
"lastUpdatedBy": "Michael",
"lastUpdatedOn": "2022-08-10 13:22:12"
},
"customerOwnerId": "1590403923849282893",
"customerOwnerName": "Ella",
"crmId": "35d03rf9e0-30938id0309242",
"commissionRate": 0.3,
"category": "大客户",
"province": "北京",
"city": "北京",
"region": "海淀区",
"address": "北京市海淀区八里庄路62号院1号楼10层1124号",
"note": "北京阅丰科技有限公司成立于2022年02月22日,注册地位于北京市海淀区八里庄路62号院1号楼10层1124号,法定代表人为毛炜",
"contacts": [
{
"name": "Michael",
"title": "项目经理",
"phoneNumber": "13533333333",
"eamilAddress": "michael.zhou@gmail.com",
"createdBy": "Ella",
"createdOn": "2022-08-01 18:43:25",
"lastUpdatedBy": "Michael",
"lastUpdatedOn": "2022-08-10 13:22:12"
}
],
"createdBy": "Ella",
"createdOn": "2022-08-01 18:43:25",
"lastUpdatedBy": "Michael",
"lastUpdatedOn": "2022-08-10 13:22:12"
},
"message": "请求成功",
"success": true
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
GET 删除客户
接口地址 /bee/api/v1/customers/{customer-id}
请求方式 DELETE
请求参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
customer-id | customer-id | path | true | integer |
响应状态
状态码 | 说明 | schema |
---|---|---|
200 | OK | ResponseData |
204 | No Content | |
401 | Unauthorized | |
403 | Forbidden |
响应参数
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | 响应状态码 | integer(int32) | integer(int32) |
data | 通用返回数据 | object | |
message | 状态描述信息 | string | |
success | 是否成功 | boolean |
响应示例
{
"code": 200
"message": "请求成功",
"success": true
}
2
3
4
5
如调用API返回异常,可点击这里查看异常资源代码。