帮助中心
所有文章
使用指南
功能概览
API 文档
API 介绍
API 更新日志
API 授权
API 请求与响应
API 异常处理
API 资源代码
API 分页
API 版本
订阅蜂 CPQ API
获取App Token
获取Tenant Token
获取User Token
组织架构 API
报价单 API
报价单模版 API
客户 API
商机 API
产品 API
了解更多
API 文档
订阅蜂 CPQ API
商机 API
商机 API
最后更新于 2023/08/04   阅读数 198

创建商机

接口地址 /bee/api/v1/opportunities

请求方式 POST

consumes ["application/json"]

produces ["*/*"]

请求示例

{
  "opportunityName": "共创机会",
  "customerId": "1590403923849282800",
  "crmId": "1590403923849282802",
  "salesRespPhone": "13522222222",
  "salesAmount": 100,
  "salesPhase": "初期阶段",
  "closeDate": "2022-08-31",
  "notes": "this is notes",
  "productChargePlanIds": [
    "1590403923849282800"
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
json

创建销售机会

参数名称

参数说明

请求类型

是否必须

数据类型

schema

closeDate

结单日期

pattern(yyyy-MM-dd)

body

false

string(date-time)

customerId

客户ID

body

false

integer(int64)

crmId

对外crm id

body

false

integer(int64)

notes

备注

body

false

string

opportunityName

机会名称

body

false

string

salesRespPhone

销售经理手机号

body

false

string

productChargePlanIds

产品定价计划ID

body

false

array

salesAmount

销售金额

body

false

number

salesPhase

销售阶段：

1.初步接洽

2.需求确定

3.方案/报价

4.谈判审核

5.赢单

6.输单

body

false

integer(int32)

响应状态

状态码

说明

schema

200

OK

ResponseData«销售机会»

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

销售机会vo

销售机会vo

message

状态描述信息

string

success

是否成功

boolean

schema属性说明

销售机会

参数名称

参数说明

类型

schema

closeDate

结单日期

string

customerId

客户ID

integer(int64)

customerName

客户名称

string

id

机会id

integer(int64)

crmId

对外crm id

integer(int64)

notes

备注

string

opportunityName

机会名称

string

salesRespPhone

销售经理手机号

string

opportunityOwnerName

销售经理名称

string

productChargePlanIds

定价计划ID

array

salesAmount

销售金额

integer(int32)

salesPhase

销售阶段

1.初步接洽

2.需求确定

3.方案/报价

4.谈判审核

5.赢单

6.输单

integer(int32)

salesPhaseDesc

销售阶段

1.初步接洽

2.需求确定

3.方案/报价

4.谈判审核

5.赢单

6.输单

string

响应示例

{
  "code": 200,
  "data": {
    "id": "1590403923849282800",
    "opportunityName": "共创机会",
    "customerId": "1590403923849282800",
    "crmId": "1590403923849282802",
    "salesRespPhone": "13522222222",
    "customerName": "订阅蜂科技",
    "opportunityOwnerId": "1590403923849282800",
    "opportunityOwnerName": "Michael",
    "salesAmount": 100,
    "salesPhase": "初期阶段",
    "closeDate": "2022-08-31",
    "notes": "this is notes",
    "productChargePlanIds": [
      "1590403923849282800"
    ]
  },
  "message": "请求成功",
  "success": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
json

查询商机

接口地址 /bee/api/v1/opportunities/{opportunity-id}

请求方式 GET

consumes ``

produces ["*/*"]

接口描述 ``

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

opportunity-id

opportunity-id

path

true

integer

响应状态

状态码

说明

schema

200

OK

ResponseData«销售机会vo»

401

Unauthorized

403

Forbidden

404

Not Found

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

销售机会vo

销售机会vo

message

状态描述信息

string

success

是否成功

boolean

schema属性说明

销售机会vo

参数名称

参数说明

类型

schema

closeDate

结单日起

string

customerId

客户ID

integer(int64)

customerName

客户名称

string

id

机会id

integer(int64)

crmId

对外crm id

integer(int64)

notes

备注

string

opportunityName

机会名称

string

salesRespPhone

销售经理手机号

string

opportunityOwnerName

销售经理名称

string

productChargePlanIds

定价计划ID

array

salesAmount

销售金额

integer(int32)

salesPhase

销售阶段：1.初步接洽2.需求确定3.方案/报价4.谈判审核5.赢单6.输单

integer(int32)

salesPhaseDesc

销售阶段1.初步接洽2.需求确定3.方案/报价4.谈判审核5.赢单6.输单

string

响应示例

{
  "code": 200,
  "data": {
    "id": "1590403923849282800",
    "opportunityName": "共创机会",
    "customerId": "1590403923849282800",
    "crmId": "1590403923849282802",
    "salesRespPhone": "13522222222",
    "customerName": "订阅蜂科技",
    "salesAmount": 100,
    "salesPhase": "初期阶段",
    "closeDate": "2022-08-31",
    "notes": "this is notes",
    "productChargePlanIds": [
      "1590403923849282800"
    ]
  },
  "message": "请求成功",
  "success": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
json

修改商机

接口地址 /bee/api/v1/opportunities/{opportunity-id}

请求方式 PUT

consumes ["application/json"]

produces ["*/*"]

接口描述 ``

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

opportunity-id

机会ID

path

true

integer(int64)

UpdateOpportunitiesDto

请求示例

{
  "opportunityName": "共创机会",
  "customerId": "1590403923849282800",
  "crmId": "1590403923849282802",
  "salesRespPhone": "13522222222",
  "salesAmount": 100,
  "salesPhase": "初期阶段",
  "closeDate": "2022-08-31",
  "notes": "this is notes",
  "productChargePlanIds": [
    "1590403923849282800"
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
json

schema属性说明

UpdateOpportunitiesDto

参数名称

参数说明

请求类型

是否必须

数据类型

schema

closeDate

结单日期

pattern(yyyy-MM-dd)

body

false

string(date-time)

notes

备注

body

false

string

opportunityName

机会名称

body

false

string

productChargePlanIds

产品定价计划ID

body

false

array

salesAmount

销售金额

body

false

number

salesPhase

销售阶段：

1.初步接洽

2.需求确定

3.方案/报价

4.谈判审核

5.赢单

6.输单

body

false

integer(int32)

响应状态

状态码

说明

schema

200

OK

ResponseData«销售机会vo»

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

销售机会vo

销售机会vo

message

状态描述信息

string

success

是否成功

boolean

schema属性说明

销售机会vo

参数名称

参数说明

类型

schema

closeDate

结单日期

string

customerId

客户ID

integer(int64)

customerName

客户名称

string

id

机会id

integer(int64)

crmId

对外crmId

integer(int64)

notes

备注

string

opportunityName

机会名称

string

salesRespPhone

销售经理手机号

integer(int64)

productChargePlanIds

定价计划ID

array

salesAmount

销售金额

integer(int32)

salesPhase

销售阶段：1.初步接洽2.需求确定3.方案/报价4.谈判审核5.赢单6.输单

integer(int32)

salesPhaseDesc

销售阶段：1.初步接洽2.需求确定3.方案/报价4.谈判审核5.赢单6.输单

string

响应示例

{
  "code": 200,
  "data": {
    "id": "1590403923849282800",
    "opportunityName": "共创机会",
    "customerId": "1590403923849282800",
    "customerName": "订阅蜂科技",
    "crmId": "1590403923849282802",
    "salesRespPhone": "13522222222",
    "salesAmount": 100,
    "salesPhase": "初期阶段",
    "closeDate": "2022-08-31",
    "notes": "this is notes",
    "productChargePlanIds": [
      "1590403923849282800"
    ]
  },
  "message": "请求成功",
  "success": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
json

删除商机

接口地址 /bee/api/v1/opportunities/{opportunity-id}

请求方式 DELETE

consumes ``

produces ["*/*"]

接口描述 ``

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

opportunity-id

opportunity-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
}
1
2
3
4
5
json
上一篇
客户 API
下一篇
产品 API
本篇目录

创建商机

查询商机

修改商机

删除商机