帮助中心
所有文章
使用指南
功能概览
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/09/28   阅读数 175

POST 创建标准产品

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

请求方式 POST

请求示例

{
  "name": "CPQ 云报价",
  "category": "产品",
  "referenceId": "100XO2390420001",
  "notes": "帮助企业快速准确报价",
  "chargeType": "年",
  "uom": "人",
  "price": 1000.00,
  "discountType": "amount",
  "discount": 200.00,
  
}
1
2
3
4
5
6
7
8
9
10
11
12
json

请求参数说明

参数名称

参数说明

请求类型

是否必须

数据类型

schema

category

产品分类

body

true

string

chargeType

定价周期

(一次性，年，月）

body

true

string

discount

折扣金额

body

false

number

discountType

折扣类型

(amount, percentage)

body

false

string

name

产品名称

body

true

string

notes

描述

body

false

string

price

价格

body

true

number

referenceId

参考 ID

body

false

string

uom

定价单位

body

false

string

响应状态

状态码

说明

schema

200

OK

ResponseData«CreateReturnProductVo»

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

CreateReturnProductVo

CreateReturnProductVo

message

状态描述信息

string

success

是否成功

boolean

schema属性说明

CreateReturnProductVo

参数名称

参数说明

类型

schema

category

产品分类

string

createdBy

创建人

string

createdOn

创建时间

string(date-time)

id

产品id

integer(int64)

lastUpdatedBy

修改人

string

lastUpdatedOn

修改时间

string(date-time)

name

产品名称

string

notes

描述

string

number

编号

string

referenceId

内部引用Id

string

status

上下架状态

string

响应示例

{
  "code": 200,
  "data": {
    "id": "1590403923849282800",
    "name": "CPQ 云报价",
    "number": "P-00000001",
    "category": "产品",
    "referenceId": "100XO2390420001",
    "status": "inactive",
    "notes": "帮助企业快速准确报价",
    "createdBy": "Ella",
    "createdOn": "2022-08-01 18:43:25",
    "lastUpdatedBy": "Michael",
    "lastUpdatedOn": "2022-08-10 13:22:12"
  },
  "message": "请求成功",
  "success": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
json

PUT 修改产品基本信息

接口地址 /bee/api/v1/products/{product-id}/basic-info

请求方式 PUT

consumes ["application/json"]

produces ["*/*"]

请求示例

{
  "name": "CPQ 云报价",
  "category": "SaaS 产品",
  "referenceId": "100XO2390420001",
  "notes": "帮助企业快速准确报价",
  "attributes": [
    "销售渠道"
  ]
}
1
2
3
4
5
6
7
8
9
json

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

product-id

product-id

path

true

string

productInfoVo

productInfoVo

body

true

ProductAPiInfoVo

ProductAPiInfoVo

schema属性说明

ProductAPiInfoVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

category

产品分类

body

false

string

name

产品名称

body

false

string

notes

描述

body

false

string

referenceId

内部引用Id

body

false

string

响应状态

状态码

说明

schema

200

OK

ResponseData«CreateReturnProductVo»

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

CreateReturnProductVo

CreateReturnProductVo

message

状态描述信息

string

success

是否成功

boolean

schema属性说明

CreateReturnProductVo

参数名称

参数说明

类型

schema

category

产品分类

string

createdBy

创建人

string

createdOn

创建时间

string(date-time)

id

产品id

integer(int64)

lastUpdatedBy

修改人

string

lastUpdatedOn

修改时间

string(date-time)

name

产品名称

string

notes

描述

string

number

编号

string

referenceId

内部引用Id

string

status

上下架状态

string

响应示例

{
  "code": 200,
  "data": {
    "id": "1590403923849282800",
    "name": "CPQ 云报价",
    "number": "P-00000001",
    "category": "SaaS 产品",
    "referenceId": "100XO2390420001",
    "status": "activated",
    "notes": "帮助企业快速准确报价",
    "createdBy": "Ella",
    "createdOn": "2022-08-01 18:43:25",
    "lastUpdatedBy": "Michael",
    "lastUpdatedOn": "2022-08-10 13:22:12"
  },
  "message": "请求成功",
  "success": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
json

PUT 产品上架

接口地址 /bee/api/v1/products/{product-id}/activate

请求方式 PUT

consumes ["application/json"]

produces ["*/*"]

接口描述 ``

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

product-id

产品 ID

path

true

integer

响应状态

状态码

说明

schema

200

OK

ResponseData«CreateReturnProductVo»

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

CreateReturnProductVo

CreateReturnProductVo

message

状态描述信息

string

success

是否成功

boolean

schema属性说明

CreateReturnProductVo

参数名称

参数说明

类型

schema

category

产品分类

string

createdBy

创建人

string

createdOn

创建时间

string(date-time)

id

产品id

integer(int64)

lastUpdatedBy

修改人

string

lastUpdatedOn

修改时间

string(date-time)

name

产品名称

string

notes

描述

string

number

编号

string

referenceId

内部引用Id

string

status

上下架状态

string

响应示例

{
  "code": 200,
  "data": {
    "id": "1590403923849282800",
    "name": "CPQ 云报价",
    "number": "P-00000001",
    "category": "产品",
    "referenceId": "100XO2390420001",
    "status": "active",
    "notes": "帮助企业快速准确报价",
    "createdBy": "Ella",
    "createdOn": "2022-08-01 18:43:25",
    "lastUpdatedBy": "Michael",
    "lastUpdatedOn": "2022-08-10 13:22:12"
  },
  "message": "请求成功",
  "success": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
json

PUT 产品下架

接口地址 /bee/api/v1/products/{product-id}/deactivate

请求方式 PUT

consumes ["application/json"]

produces ["*/*"]

接口描述 ``

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

product-id

产品 ID

path

true

integer

响应状态

状态码

说明

schema

200

OK

ResponseData«CreateReturnProductVo»

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

CreateReturnProductVo

CreateReturnProductVo

message

状态描述信息

string

success

是否成功

boolean

schema属性说明

CreateReturnProductVo

参数名称

参数说明

类型

schema

category

产品分类

string

createdBy

创建人

string

createdOn

创建时间

string(date-time)

id

产品id

integer(int64)

lastUpdatedBy

修改人

string

lastUpdatedOn

修改时间

string(date-time)

name

产品名称

string

notes

描述

string

number

编号

string

referenceId

内部引用Id

string

status

上下架状态

string

响应示例

{
  "code": 200,
  "data": {
    "id": "1590403923849282800",
    "name": "CPQ 云报价",
    "number": "P-00000001",
    "category": "产品",
    "referenceId": "100XO2390420001",
    "status": "inactive",
    "notes": "帮助企业快速准确报价",
    "createdBy": "Ella",
    "createdOn": "2022-08-01 18:43:25",
    "lastUpdatedBy": "Michael",
    "lastUpdatedOn": "2022-08-10 13:22:12"
  },
  "message": "请求成功",
  "success": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
json

DELETE 删除产品

接口地址 /bee/api/v1/products/{product-id}

请求方式 DELETE

consumes ``

produces ["*/*"]

接口描述 ``

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

product-id

product-id

path

true

string

响应状态

状态码

说明

schema

200

OK

ResponseData

204

No Content

401

Unauthorized

403

Forbidden

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int3)

integer(int32)

data

通用返回数据

object

message

状态描述信息

string

success

是否成功

boolean

响应示例

{
	"code": 200
}
1
2
3
json

POST 创建复杂定价产品

接口地址 /bee/api/v1/products/complex-pricing

请求方式 POST

consumes ["application/json"]

produces ["*/*"]

请求示例

{
  "name": "CPQ 云报价",
  "number": "P-00000001",
  "category": "SaaS 产品",
  "referenceId": "100XO2390420001",
  "notes": "帮助企业快速准确报价",
  "attributes": [
    "销售渠道"
  ],
  "editions": [
    {
      "productId": 1590043857465746400,
      "name": "Seed Edition",
      "descritpion": "10 人以内版本",
      "entitlements": [
        "10 个预置模版"
      ]
    }
  ],
  "features": [
    {
      "productId": 1590043857465746400,
      "name": "报价",
      "descritpion": "报价管理",
      "items": [
        {
          "featureId": 1590043857465746400,
          "name": "对外报价",
          "descritpion": "销售人员对外报价",
          "referenceId": "ref-001-xx-1",
          "editionValues": [
            {
              "edition": "Seed edition",
              "valueType": 0,
              "value": "包含"
            }
          ]
        }
      ]
    }
  ],
  "chargePlans": [
    {
      "productId": 1590043857465746400,
      "name": "钉钉",
      "descritpion": "钉钉定价方案",
      "edition": "基础版",
      "attributes": [
        {
          "name": "渠道",
          "value": "钉钉"
        }
      ],
      "charges": [
        {
          "chargePlanId": 1590043857465746400,
          "name": "年费",
          "chargeType": "年",
          "minTerm": 1,
          "maxTerm": 100,
          "chargePrice": {
            "chargeModel": "固定定价",
            "listPrice": 100,
            "rangePriceType": "单价",
            "rangePrices": [
              {
                "rangeNo": 1,
                "rangeFrom": 1,
                "rangeTo": "1,000",
                "price": 5
              }
            ],
            "cost": 60,
            "commissionRate": 0.03,
            "uom": "天",
            "minQty": 1,
            "maxQty": "1,000"
          },
          "hasDiscount": true,
          "discount": {
            "discountModel": "固定折扣",
            "discountType": "金额",
            "discount": 100,
            "rangeValueType": "数量",
            "rangeDiscounts": [
              {
                "rangeNo": 1,
                "rangeFrom": 1,
                "rangeTo": "1,000",
                "price": 5
              }
            ]
          }
        }
      ]
    }
  ]
}
1
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
json

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

complexVo

complexVo

body

true

CreateProductComplexVo

CreateProductComplexVo

schema属性说明

CreateProductComplexVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

attributes

关联属性

body

false

array

category

产品分类

body

false

string

chargePlans

定价计划信息

body

false

array

CreateProductPlanVo

editions

版本信息

body

false

array

EditionVo

features

功能信息

body

false

array

FeatureVo

name

产品名称

body

false

string

notes

描述

body

false

string

referenceId

内部引用Id

body

false

string

CreateProductPlanVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

attributes

属性

body

false

array

ApiAttributeVo

charges

计费明细项数据

body

false

array

创建产品计费明细项

description

定价计划描述

body

false

string

edition

版本

body

false

string

name

定价计划名称

body

false

string

productId

产品Id

body

false

integer(int64)

ApiAttributeVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

name

名称

body

false

string

value

值

body

false

string

创建产品计费明细项

参数名称

参数说明

请求类型

是否必须

数据类型

schema

chargePlanId

产品定价计划Id

body

false

integer(int64)

chargePrice

价格数据

body

false

ChargePriceVo

ChargePriceVo

chargeType

定价周期

body

false

string

discount

折扣数据

body

false

DiscountPriceVo

DiscountPriceVo

hasDiscount

折扣开启(true;false)

body

false

boolean

id

计费项返回id

body

false

integer(int64)

maxTerm

最大周期

body

false

integer(int32)

minTerm

最小周期

body

false

integer(int32)

name

名称

body

false

string

productId

产品Id

body

false

integer(int64)

taxRateName

税的名称

body

false

string

ChargePriceVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

chargeModel

定价模式

body

false

string

commissionRate

佣金率

body

false

number

cost

成本

body

false

number

listPrice

价格

body

false

number

maxQty

最大额度

body

false

integer(int32)

minQty

最小额度

body

false

integer(int32)

rangePriceType

区间价格

body

false

string

rangePrices

价格区间

body

false

array

RangeVo

uom

定价单位(固定定价没有)

body

false

string

RangeVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

price

价格

body

false

number

rangeFrom

开始区间

body

false

number

rangeTo

结束区间

body

false

number

DiscountPriceVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

discount

固定折扣使用保存值

body

false

number

discountModel

折扣模式

body

false

string

discountType

折扣类型(金额;%)

body

false

string

rangeDiscounts

折扣价格区间

body

false

array

RangeVo

rangeValueType

区间值类型

body

false

string

EditionVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

description

描述

body

false

string

entitlements

权益项

body

false

array

name

名称

body

false

string

FeatureVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

description

body

false

string

items

body

false

array

ItemVo

name

body

false

string

ItemVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

description

body

false

string

editionValues

body

false

array

EditionRefVo

name

body

false

string

referenceId

可以关联ERP或者公司内部的ID

body

false

string

EditionRefVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

edition

body

false

string

value

body

false

string

valueType

body

false

integer(int32)

响应状态

状态码

说明

schema

200

OK

ResponseData«ReturnProductComplexVo»

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

ReturnProductComplexVo

ReturnProductComplexVo

message

状态描述信息

string

success

是否成功

boolean

schema属性说明

ReturnProductComplexVo

参数名称

参数说明

类型

schema

attributes

关联属性

array

category

产品分类

string

chargePlans

定价计划信息

array

ReturnCreatePlanVo

editions

版本信息

array

EditionVo

features

功能信息

array

FeatureVo

name

产品名称

string

notes

描述

string

productId

产品id

integer(int64)

referenceId

内部引用Id

string

ReturnCreatePlanVo

参数名称

参数说明

类型

schema

attributes

属性

array

ApiAttributeVo

chargePlanId

定价计划Id

integer(int64)

charges

计费明细项数据

array

创建产品计费明细项

description

定价计划描述

string

edition

版本

string

name

定价计划名称

string

productId

产品Id

integer(int64)

ApiAttributeVo

参数名称

参数说明

类型

schema

name

名称

string

value

值

string

创建产品计费明细项

参数名称

参数说明

类型

schema

chargePlanId

产品定价计划Id

integer(int64)

chargePrice

价格数据

ChargePriceVo

ChargePriceVo

chargeType

定价周期

string

discount

折扣数据

DiscountPriceVo

DiscountPriceVo

hasDiscount

折扣开启(true;false)

boolean

id

计费项返回id

integer(int64)

maxTerm

最大周期

integer(int32)

minTerm

最小周期

integer(int32)

name

名称

string

productId

产品Id

integer(int64)

taxRateName

税的名称

string

ChargePriceVo

参数名称

参数说明

类型

schema

chargeModel

定价模式

string

commissionRate

佣金率

number

cost

成本

number

listPrice

价格

number

maxQty

最大额度

integer(int32)

minQty

最小额度

integer(int32)

rangePriceType

区间价格

string

rangePrices

价格区间

array

RangeVo

uom

定价单位(固定定价没有)

string

RangeVo

参数名称

参数说明

类型

schema

price

价格

number

rangeFrom

开始区间

number

rangeTo

结束区间

number

DiscountPriceVo

参数名称

参数说明

类型

schema

discount

固定折扣使用保存值

number

discountModel

折扣模式

string

discountType

折扣类型(金额;%)

string

rangeDiscounts

折扣价格区间

array

RangeVo

rangeValueType

区间值类型

string

EditionVo

参数名称

参数说明

类型

schema

description

描述

string

entitlements

权益项

array

name

名称

string

FeatureVo

参数名称

参数说明

类型

schema

description

string

items

array

ItemVo

name

string

ItemVo

参数名称

参数说明

类型

schema

description

string

editionValues

array

EditionRefVo

name

string

referenceId

可以关联ERP或者公司内部的ID

string

EditionRefVo

参数名称

参数说明

类型

schema

edition

string

value

string

valueType

integer(int32)

响应示例

{
  "code": 200,
  "data": {
    "id": "1590403923849282800",
    "name": "CPQ 云报价",
    "number": "P-00000001",
    "category": "SaaS 产品",
    "referenceId": "100XO2390420001",
    "status": "activated",
    "notes": "帮助企业快速准确报价",
    "createdBy": "Ella",
    "createdOn": "2022-08-01 18:43:25",
    "lastUpdatedBy": "Michael",
    "lastUpdatedOn": "2022-08-10 13:22:12"
  },
  "message": "请求成功",
  "success": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
json

GET 查询产品详情

接口地址 /bee/api/v1/products/{product-id}/details

请求方式 GET

consumes ["application/json"]

produces ["*/*"]

接口描述 ``

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

product-id

product-id

path

true

string

响应状态

状态码

说明

schema

200

OK

ResponseData«ReturnProductComplexVo»

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

ReturnProductComplexVo

ReturnProductComplexVo

message

状态描述信息

string

success

是否成功

boolean

schema属性说明

ReturnProductComplexVo

参数名称

参数说明

类型

schema

attributes

关联属性

array

category

产品分类

string

chargePlans

定价计划信息

array

ReturnCreatePlanVo

editions

版本信息

array

EditionVo

features

功能信息

array

FeatureVo

name

产品名称

string

notes

描述

string

productId

产品id

integer(int64)

referenceId

内部引用Id

string

ChargePlanVo

参数名称

参数说明

类型

schema

attributes

属性

array

ApiAttributeVo

chargePlanId

定价计划Id

integer(int64)

charges

计费明细项数据

array

创建产品计费明细项

description

定价计划描述

string

edition

版本

string

name

定价计划名称

string

productId

产品Id

integer(int64)

ApiAttributeVo

参数名称

参数说明

类型

schema

name

名称

string

value

值

string

ChargeVo

参数名称

参数说明

类型

schema

chargePlanId

产品定价计划Id

integer(int64)

chargePrice

价格数据

ChargePriceVo

ChargePriceVo

chargeType

定价周期

string

discount

折扣数据

DiscountPriceVo

DiscountPriceVo

hasDiscount

折扣开启(true;false)

boolean

id

计费项返回id

integer(int64)

maxTerm

最大周期

integer(int32)

minTerm

最小周期

integer(int32)

name

名称

string

productId

产品Id

integer(int64)

taxRateName

税的名称

string

ChargePriceVo

参数名称

参数说明

类型

schema

chargeModel

定价模式

string

commissionRate

佣金率

number

cost

成本

number

listPrice

价格

number

maxQty

最大额度

integer(int32)

minQty

最小额度

integer(int32)

rangePriceType

区间价格

string

rangePrices

价格区间

array

RangeVo

uom

定价单位(固定定价没有)

string

RangeVo

参数名称

参数说明

类型

schema

price

价格

number

rangeFrom

开始区间

number

rangeTo

结束区间

number

DiscountPriceVo

参数名称

参数说明

类型

schema

discount

固定折扣使用保存值

number

discountModel

折扣模式

string

discountType

折扣类型(金额;%)

string

rangeDiscounts

折扣价格区间

array

RangeVo

rangeValueType

区间值类型

string

EditionVo

参数名称

参数说明

类型

schema

description

描述

string

entitlements

权益项

array

name

名称

string

FeatureVo

参数名称

参数说明

类型

schema

description

string

items

array

ItemVo

name

string

ItemVo

参数名称

参数说明

类型

schema

description

string

editionValues

array

EditionRefVo

name

string

referenceId

可以关联ERP或者公司内部的ID

string

EditionRefVo

参数名称

参数说明

类型

schema

edition

string

value

string

valueType

integer(int32)

响应示例

{
    "code": 200,
    "data": {
        "attributes": [
            {
                "name": "版本",
                "value": "专业版;企业版"
            },
            {
                "name": "规格",
                "value": "5000;5万;50万"
            }
        ],
        "category": "产品",
        "chargePlans": [
            {
                "attributes": [
                    {
                        "name": "版本",
                        "value": "企业版;专业版"
                    }
                ],
                "charges": [
                    {
                        "chargePlanId": "1610107805654142978",
                        "chargePrice": {
                            "chargeModel": "固定定价",
                            "commissionRate": null,
                            "cost": null,
                            "listPrice": 4900.000000,
                            "maxQty": null,
                            "minQty": 1,
                            "rangePriceType": "总价",
                            "rangePrices": [],
                            "uom": ""
                        },
                        "chargeType": "年",
                        "discount": null,
                        "give": null,
                        "hasDiscount": false,
                        "hasGive": false,
                        "id": "1610107805687697409",
                        "maxTerm": null,
                        "minTerm": 1,
                        "name": "订阅",
                        "productId": "1610107805608005634",
                        "taxRateName": ""
                    },
                    {
                        "chargePlanId": "1610107805654142978",
                        "chargePrice": {
                            "chargeModel": "阶梯定价",
                            "commissionRate": null,
                            "cost": 0.00,
                            "listPrice": null,
                            "maxQty": null,
                            "minQty": 1,
                            "rangePriceType": "单价",
                            "rangePrices": [
                                {
                                    "price": 1000.000000,
                                    "rangeFrom": 1.00,
                                    "rangeTo": 2.00
                                },
                                {
                                    "price": 2000.000000,
                                    "rangeFrom": 3.00,
                                    "rangeTo": 999999999999999999.99
                                }
                            ],
                            "uom": "个"
                        },
                        "chargeType": "年",
                        "discount": null,
                        "give": null,
                        "hasDiscount": false,
                        "hasGive": false,
                        "id": "1610107805704474626",
                        "maxTerm": null,
                        "minTerm": 1,
                        "name": "客户成功服务",
                        "productId": "1610107805608005634",
                        "taxRateName": ""
                    },
                    {
                        "chargePlanId": "1610107805654142978",
                        "chargePrice": {
                            "chargeModel": "按单位定价",
                            "commissionRate": null,
                            "cost": 0.00,
                            "listPrice": 300.000000,
                            "maxQty": null,
                            "minQty": 1,
                            "rangePriceType": "总价",
                            "rangePrices": [],
                            "uom": "天"
                        },
                        "chargeType": "一次性",
                        "discount": {
                            "discount": 20.000000,
                            "discountModel": "固定折扣",
                            "discountType": "%",
                            "rangeDiscounts": [],
                            "rangeValueType": "金额"
                        },
                        "give": {
                            "give": 10.000000,
                            "giveModel": "固定折扣",
                            "rangeGives": [],
                            "rangeValueType": "数量"
                        },
                        "hasDiscount": true,
                        "hasGive": true,
                        "id": "1610107805712863235",
                        "maxTerm": null,
                        "minTerm": 1,
                        "name": "上线实施",
                        "productId": "1610107805608005634",
                        "taxRateName": ""
                    }
                ],
                "description": "这是一个示例定价计划",
                "edition": "",
                "id": "1610107805654142978",
                "name": "专业版,企业版",
                "productId": "1610107805608005634"
            },
            {
                "attributes": [
                    {
                        "name": "版本",
                        "value": "企业版"
                    }
                ],
                "charges": [
                    {
                        "chargePlanId": "1610107805658337281",
                        "chargePrice": {
                            "chargeModel": "固定定价",
                            "commissionRate": null,
                            "cost": null,
                            "listPrice": 9900.000000,
                            "maxQty": null,
                            "minQty": 1,
                            "rangePriceType": "总价",
                            "rangePrices": [],
                            "uom": ""
                        },
                        "chargeType": "年",
                        "discount": null,
                        "give": null,
                        "hasDiscount": false,
                        "hasGive": false,
                        "id": "1610107805742223361",
                        "maxTerm": null,
                        "minTerm": 1,
                        "name": "订阅",
                        "productId": "1610107805608005634",
                        "taxRateName": ""
                    },
                    {
                        "chargePlanId": "1610107805658337281",
                        "chargePrice": {
                            "chargeModel": "固定定价",
                            "commissionRate": null,
                            "cost": null,
                            "listPrice": 990.000000,
                            "maxQty": null,
                            "minQty": 1,
                            "rangePriceType": "总价",
                            "rangePrices": [],
                            "uom": ""
                        },
                        "chargeType": "年",
                        "discount": {
                            "discount": 15.000000,
                            "discountModel": "固定折扣",
                            "discountType": "%",
                            "rangeDiscounts": [],
                            "rangeValueType": "数量"
                        },
                        "give": null,
                        "hasDiscount": true,
                        "hasGive": false,
                        "id": "1610107805771583489",
                        "maxTerm": null,
                        "minTerm": 1,
                        "name": "客户成功服务",
                        "productId": "1610107805608005634",
                        "taxRateName": ""
                    },
                    {
                        "chargePlanId": "1610107805658337281",
                        "chargePrice": {
                            "chargeModel": "固定定价",
                            "commissionRate": null,
                            "cost": null,
                            "listPrice": 500.000000,
                            "maxQty": null,
                            "minQty": 1,
                            "rangePriceType": "总价",
                            "rangePrices": [],
                            "uom": ""
                        },
                        "chargeType": "一次性",
                        "discount": null,
                        "give": null,
                        "hasDiscount": false,
                        "hasGive": false,
                        "id": "1610107805792555010",
                        "maxTerm": null,
                        "minTerm": 1,
                        "name": "上线实施",
                        "productId": "1610107805608005634",
                        "taxRateName": ""
                    }
                ],
                "description": "这是一个示例定价计划",
                "edition": "",
                "id": "1610107805658337281",
                "name": "企业版",
                "productId": "1610107805608005634"
            }
        ],
        "editions": [
            {
                "description": "THIS IS DEMO",
                "entitlements": [
                    "111",
                    "222"
                ],
                "name": "V1"
            },
            {
                "description": "V2 DESCRIPTION",
                "entitlements": [
                    "333",
                    "444"
                ],
                "name": "V2"
            }
        ],
        "features": [
            {
                "description": "C1 DESCRIPTION",
                "items": [
                    {
                        "description": "F1 DESCRIPTION",
                        "editionValues": [
                            {
                                "edition": "V1",
                                "value": "包含",
                                "valueType": 1
                            },
                            {
                                "edition": "V2",
                                "value": "不包含",
                                "valueType": 1
                            }
                        ],
                        "name": "F1",
                        "referenceId": "INTERNAL ID"
                    },
                    {
                        "description": "F2 DESCRIPTION",
                        "editionValues": [
                            {
                                "edition": "V1",
                                "value": "X",
                                "valueType": 2
                            },
                            {
                                "edition": "V2",
                                "value": "Y",
                                "valueType": 2
                            }
                        ],
                        "name": "F2",
                        "referenceId": "INTERNAL ID"
                    }
                ],
                "name": "C1"
            },
            {
                "description": "C2 DESCRIPTION",
                "items": [
                    {
                        "description": "C2F1 DESCRIPTION",
                        "editionValues": [
                            {
                                "edition": "V1",
                                "value": "不包含",
                                "valueType": 1
                            },
                            {
                                "edition": "V2",
                                "value": "包含",
                                "valueType": 1
                            }
                        ],
                        "name": "C2F1",
                        "referenceId": "INTERNAL"
                    }
                ],
                "name": "C2"
            }
        ],
        "id": "1610107805608005634",
        "name": "订阅蜂 CPQ",
        "notes": "这是一个是示例产品",
        "referenceId": "X202209220099Y001"
    },
    "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
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
json

POST 创建产品定价计划

接口地址 /bee/api/v1/product-charge-plans

请求方式 POST

consumes ["application/json"]

produces ["*/*"]

请求示例
1
json

请求示例

{
  "productId": 1590043857465746400,
  "name": "钉钉",
  "descritpion": "钉钉定价方案",
  "edition": "基础版",
  "attributes": [
    {
      "name": "渠道",
      "value": "钉钉"
    }
  ],
  "charges": [
    {
      "chargePlanId": 1590043857465746400,
      "name": "年费",
      "chargeType": "年",
      "minTerm": 1,
      "maxTerm": 100,
      "chargePrice": {
        "chargeModel": "固定定价",
        "listPrice": 100,
        "rangePriceType": "单价",
        "rangePrices": [
          {
            "rangeNo": 1,
            "rangeFrom": 1,
            "rangeTo": "1,000",
            "price": 5
          }
        ],
        "cost": 60,
        "commissionRate": 0.03,
        "uom": "天",
        "minQty": 1,
        "maxQty": "1,000"
      },
      "hasDiscount": true,
      "discount": {
        "discountModel": "固定折扣",
        "discountType": "金额",
        "discount": 100,
        "rangeValueType": "数量",
        "rangeDiscounts": [
          {
            "rangeNo": 1,
            "rangeFrom": 1,
            "rangeTo": "1,000",
            "price": 5
          }
        ]
      }
    }
  ]
}
1
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
49
50
51
52
53
54
55
json

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

vo

vo

body

true

CreateProductPlanVo

CreateProductPlanVo

schema属性说明

CreateProductPlanVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

attributes

属性

body

false

array

ApiAttributeVo

charges

计费明细项数据

body

false

array

创建产品计费明细项

description

定价计划描述

body

false

string

edition

版本

body

false

string

name

定价计划名称

body

false

string

productId

产品Id

body

false

integer(int64)

ApiAttributeVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

name

名称

body

false

string

value

值

body

false

string

ChargeVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

chargePlanId

产品定价计划Id

body

false

integer(int64)

chargePrice

价格数据

body

false

ChargePriceVo

ChargePriceVo

chargeType

定价周期

body

false

string

discount

折扣数据

body

false

DiscountPriceVo

DiscountPriceVo

hasDiscount

折扣开启(true;false)

body

false

boolean

id

计费项返回id

body

false

integer(int64)

maxTerm

最大周期

body

false

integer(int32)

minTerm

最小周期

body

false

integer(int32)

name

名称

body

false

string

productId

产品Id

body

false

integer(int64)

taxRateName

税的名称

body

false

string

ChargePriceVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

chargeModel

定价模式

body

false

string

commissionRate

佣金率

body

false

number

cost

成本

body

false

number

listPrice

价格

body

false

number

maxQty

最大额度

body

false

integer(int32)

minQty

最小额度

body

false

integer(int32)

rangePriceType

区间价格

body

false

string

rangePrices

价格区间

body

false

array

RangeVo

uom

定价单位(固定定价没有)

body

false

string

RangeVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

price

价格

body

false

number

rangeFrom

开始区间

body

false

number

rangeTo

结束区间

body

false

number

DiscountPriceVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

discount

固定折扣使用保存值

body

false

number

discountModel

折扣模式

body

false

string

discountType

折扣类型(金额;%)

body

false

string

rangeDiscounts

折扣价格区间

body

false

array

RangeVo

rangeValueType

区间值类型

body

false

string

响应状态

状态码

说明

schema

200

OK

ResponseData«ReturnCreatePlanVo»

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

ReturnCreatePlanVo

ReturnCreatePlanVo

message

状态描述信息

string

success

是否成功

boolean

schema属性说明

ReturnCreatePlanVo

参数名称

参数说明

类型

schema

attributes

属性

array

ApiAttributeVo

chargePlanId

定价计划Id

integer(int64)

charges

计费明细项数据

array

ChargeVo

description

定价计划描述

string

edition

版本

string

name

定价计划名称

string

productId

产品Id

integer(int64)

ApiAttributeVo

参数名称

参数说明

类型

schema

name

名称

string

value

值

string

ChargeVo

参数名称

参数说明

类型

schema

chargePlanId

产品定价计划Id

integer(int64)

chargePrice

价格数据

ChargePriceVo

ChargePriceVo

chargeType

定价周期

string

discount

折扣数据

DiscountPriceVo

DiscountPriceVo

hasDiscount

折扣开启(true;false)

boolean

id

计费项返回id

integer(int64)

maxTerm

最大周期

integer(int32)

minTerm

最小周期

integer(int32)

name

名称

string

productId

产品Id

integer(int64)

taxRateName

税的名称

string

ChargePriceVo

参数名称

参数说明

类型

schema

chargeModel

定价模式

string

commissionRate

佣金率

number

cost

成本

number

listPrice

价格

number

maxQty

最大额度

integer(int32)

minQty

最小额度

integer(int32)

rangePriceType

区间价格

string

rangePrices

价格区间

array

RangeVo

uom

定价单位(固定定价没有)

string

RangeVo

参数名称

参数说明

类型

schema

price

价格

number

rangeFrom

开始区间

number

rangeTo

结束区间

number

DiscountPriceVo

参数名称

参数说明

类型

schema

discount

固定折扣使用保存值

number

discountModel

折扣模式

string

discountType

折扣类型(金额;%)

string

rangeDiscounts

折扣价格区间

array

RangeVo

rangeValueType

区间值类型

string

响应示例

{
  "code": 200,
  "data": {
    "id": 15902039404039940000,
    "name": "钉钉",
    "descritpion": "钉钉定价方案",
    "charges": [
      {
        "id": 15902039404039940000,
        "name": "年费",
        "chargeType": "年",
        "minTerm": 1,
        "maxTerm": 100,
        "chargePrice": {
          "chargeModel": "固定定价",
          "listPrice": 100,
          "rangePriceType": "单价",
          "rangePrices": [
            {
              "rangeNo": 1,
              "rangeFrom": 1,
              "rangeTo": "1,000",
              "price": 5
            }
          ],
          "cost": 60,
          "commissionRate": 0.03,
          "uom": "天",
          "minQty": 1,
          "maxQty": "1,000"
        },
        "hasDiscount": true,
        "discount": {
          "discountModel": "固定折扣",
          "discountType": "金额",
          "discount": 100,
          "rangeValueType": "数量",
          "rangeDiscounts": [
            {
              "rangeNo": 1,
              "rangeFrom": 1,
              "rangeTo": "1,000",
              "price": 5
            }
          ]
        },
        "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
}
1
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
49
50
51
52
53
54
55
56
57
58
59
60
json

GET 查询产品定价计划

接口地址 /bee/api/v1/product-charge-plans/{charge-plan-id}

请求方式 GET

consumes ``

produces ["*/*"]

接口描述 ``

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

charge-plan-id

charge-plan-id

path

true

string

响应状态

状态码

说明

schema

200

OK

ResponseData«ReturnCreatePlanVo»

401

Unauthorized

403

Forbidden

404

Not Found

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

ReturnCreatePlanVo

ReturnCreatePlanVo

message

状态描述信息

string

success

是否成功

boolean

schema属性说明

ReturnCreatePlanVo

参数名称

参数说明

类型

schema

attributes

属性

array

ApiAttributeVo

chargePlanId

定价计划Id

integer(int64)

charges

计费明细项数据

array

创建产品计费明细项

description

定价计划描述

string

edition

版本

string

name

定价计划名称

string

productId

产品Id

integer(int64)

ApiAttributeVo

参数名称

参数说明

类型

schema

name

名称

string

value

值

string

创建产品计费明细项

参数名称

参数说明

类型

schema

chargePlanId

产品定价计划Id

integer(int64)

chargePrice

价格数据

ChargePriceVo

ChargePriceVo

chargeType

定价周期

string

discount

折扣数据

DiscountPriceVo

DiscountPriceVo

hasDiscount

折扣开启(true;false)

boolean

id

计费项返回id

integer(int64)

maxTerm

最大周期

integer(int32)

minTerm

最小周期

integer(int32)

name

名称

string

productId

产品Id

integer(int64)

taxRateName

税的名称

string

ChargePriceVo

参数名称

参数说明

类型

schema

chargeModel

定价模式

string

commissionRate

佣金率

number

cost

成本

number

listPrice

价格

number

maxQty

最大额度

integer(int32)

minQty

最小额度

integer(int32)

rangePriceType

区间价格

string

rangePrices

价格区间

array

RangeVo

uom

定价单位(固定定价没有)

string

RangeVo

参数名称

参数说明

类型

schema

price

价格

number

rangeFrom

开始区间

number

rangeTo

结束区间

number

DiscountPriceVo

参数名称

参数说明

类型

schema

discount

固定折扣使用保存值

number

discountModel

折扣模式

string

discountType

折扣类型(金额;%)

string

rangeDiscounts

折扣价格区间

array

RangeVo

rangeValueType

区间值类型

string

响应示例

{
  "code": 200,
  "data": {
    "id": 15902039404039940000,
    "name": "钉钉",
    "descritpion": "钉钉定价方案",
    "charges": [
      {
        "id": 15902039404039940000,
        "name": "年费",
        "chargeType": "年",
        "minTerm": 1,
        "maxTerm": 100,
        "chargePrice": {
          "chargeModel": "固定定价",
          "listPrice": 100,
          "rangePriceType": "单价",
          "rangePrices": [
            {
              "rangeNo": 1,
              "rangeFrom": 1,
              "rangeTo": "1,000",
              "price": 5
            }
          ],
          "cost": 60,
          "commissionRate": 0.03,
          "uom": "天",
          "minQty": 1,
          "maxQty": "1,000"
        },
        "hasDiscount": true,
        "discount": {
          "discountModel": "固定折扣",
          "discountType": "金额",
          "discount": 100,
          "rangeValueType": "数量",
          "rangeDiscounts": [
            {
              "rangeNo": 1,
              "rangeFrom": 1,
              "rangeTo": "1,000",
              "price": 5
            }
          ]
        },
        "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
}
1
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
49
50
51
52
53
54
55
56
57
58
59
60
json

PUT 更新产品定价计划

接口地址 /bee/api/v1/product-charge-plans/{charge-plan-id}

请求方式 PUT

consumes ["application/json"]

produces ["*/*"]

响应示例

{
  "name": "钉钉",
  "description": "钉钉定价方案",
  "edition": "基础版",
  "attributes": [
    {
      "name": "渠道",
      "value": "钉钉"
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
json

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

charge-plan-id

charge-plan-id

path

true

string

vo

vo

body

true

ProductPlanVo

ProductPlanVo

schema属性说明

ProductPlanVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

attributes

属性

body

false

array

ApiAttributeVo

description

定价计划描述

body

false

string

edition

版本

body

false

string

name

定价计划名称

body

false

string

ApiAttributeVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

name

名称

body

false

string

value

值

body

false

string

响应状态

状态码

说明

schema

200

OK

ResponseData«ChargePlanVo»

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

ChargePlanVo

ChargePlanVo

message

状态描述信息

string

success

是否成功

boolean

schema属性说明

ChargePlanVo

参数名称

参数说明

类型

schema

attributes

属性

array

ApiAttributeVo

chargePlanId

定价计划Id

integer(int64)

charges

计费明细项数据

array

ChargeVo

description

定价计划描述

string

edition

版本

string

name

定价计划名称

string

productId

产品Id

integer(int64)

ApiAttributeVo

参数名称

参数说明

类型

schema

name

名称

string

value

值

string

ChargeVo

参数名称

参数说明

类型

schema

chargePlanId

产品定价计划Id

integer(int64)

chargePrice

价格数据

ChargePriceVo

ChargePriceVo

chargeType

定价周期

string

discount

折扣数据

DiscountPriceVo

DiscountPriceVo

hasDiscount

折扣开启(true;false)

boolean

id

计费项返回id

integer(int64)

maxTerm

最大周期

integer(int32)

minTerm

最小周期

integer(int32)

name

名称

string

productId

产品Id

integer(int64)

taxRateName

税的名称

string

ChargePriceVo

参数名称

参数说明

类型

schema

chargeModel

定价模式

string

commissionRate

佣金率

number

cost

成本

number

listPrice

价格

number

maxQty

最大额度

integer(int32)

minQty

最小额度

integer(int32)

rangePriceType

区间价格

string

rangePrices

价格区间

array

RangeVo

uom

定价单位(固定定价没有)

string

RangeVo

参数名称

参数说明

类型

schema

price

价格

number

rangeFrom

开始区间

number

rangeTo

结束区间

number

DiscountPriceVo

参数名称

参数说明

类型

schema

discount

固定折扣使用保存值

number

discountModel

折扣模式

string

discountType

折扣类型(金额;%)

string

rangeDiscounts

折扣价格区间

array

RangeVo

rangeValueType

区间值类型

string

响应示例

{
  "code": 200,
  "data": {
    "id": 15902039404039940000,
    "name": "钉钉",
    "descritpion": "钉钉定价方案",
    "charges": [
      {
        "id": 15902039404039940000,
        "name": "年费",
        "chargeType": "年",
        "minTerm": 1,
        "maxTerm": 100,
        "chargePrice": {
          "chargeModel": "固定定价",
          "listPrice": 100,
          "rangePriceType": "单价",
          "rangePrices": [
            {
              "rangeNo": 1,
              "rangeFrom": 1,
              "rangeTo": "1,000",
              "price": 5
            }
          ],
          "cost": 60,
          "commissionRate": 0.03,
          "uom": "天",
          "minQty": 1,
          "maxQty": "1,000"
        },
        "hasDiscount": true,
        "discount": {
          "discountModel": "固定折扣",
          "discountType": "金额",
          "discount": 100,
          "rangeValueType": "数量",
          "rangeDiscounts": [
            {
              "rangeNo": 1,
              "rangeFrom": 1,
              "rangeTo": "1,000",
              "price": 5
            }
          ]
        },
        "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
}
1
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
49
50
51
52
53
54
55
56
57
58
59
60
json

DELETE 删除定价计划

接口地址 /bee/api/v1/product-charge-plans/{charge-plan-id}

请求方式 DELETE

consumes ``

produces ["*/*"]

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

charge-plan-id

charge-plan-id

path

true

string

响应状态

状态码

说明

schema

200

OK

ResponseData

204

No Content

401

Unauthorized

403

Forbidden

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

object

message

状态描述信息

string

success

是否成功

boolean

响应示例

{
	"code": 0,
	"data": {},
	"message": "",
	"success": true
}
1
2
3
4
5
6
json

POST 创建产品明细项

接口地址 /bee/api/v1/product-charges

请求方式 POST

consumes ["application/json"]

produces ["*/*"]

请求示例

{
  "chargePlanId": 1590043857465746400,
  "name": "年费",
  "chargeType": "年",
  "minTerm": 1,
  "maxTerm": 100,
  "chargePrice": {
    "chargeModel": "固定定价",
    "listPrice": 100,
    "rangePriceType": "单价",
    "rangePrices": [
      {
        "rangeNo": 1,
        "rangeFrom": 1,
        "rangeTo": "1,000",
        "price": 5
      }
    ],
    "cost": 60,
    "commissionRate": 0.03,
    "uom": "天",
    "minQty": 1,
    "maxQty": "1,000"
  },
  "hasDiscount": true,
  "discount": {
    "discountModel": "固定折扣",
    "discountType": "金额",
    "discount": 100,
    "rangeValueType": "数量",
    "rangeDiscounts": [
      {
        "rangeNo": 1,
        "rangeFrom": 1,
        "rangeTo": "1,000",
        "price": 5
      }
    ]
  }
}
1
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
json

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

createProductChargeVo

创建产品计费明细项

body

true

创建产品计费明细项

创建产品计费明细项

schema属性说明

创建产品计费明细项

参数名称

参数说明

请求类型

是否必须

数据类型

schema

chargePlanId

产品定价计划Id

body

false

integer(int64)

chargePrice

价格数据

body

false

ChargePriceVo

ChargePriceVo

chargeType

定价周期

body

false

string

discount

折扣数据

body

false

DiscountPriceVo

DiscountPriceVo

hasDiscount

折扣开启(true;false)

body

false

boolean

id

计费项返回id

body

false

integer(int64)

maxTerm

最大周期

body

false

integer(int32)

minTerm

最小周期

body

false

integer(int32)

name

名称

body

false

string

productId

产品Id

body

false

integer(int64)

taxRateName

税的名称

body

false

string

ChargePriceVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

chargeModel

定价模式

body

false

string

commissionRate

佣金率

body

false

number

cost

成本

body

false

number

listPrice

价格

body

false

number

maxQty

最大额度

body

false

integer(int32)

minQty

最小额度

body

false

integer(int32)

rangePriceType

区间价格

body

false

string

rangePrices

价格区间

body

false

array

RangeVo

uom

定价单位(固定定价没有)

body

false

string

RangeVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

price

价格

body

false

number

rangeFrom

开始区间

body

false

number

rangeTo

结束区间

body

false

number

DiscountPriceVo

参数名称

参数说明

请求类型

是否必须

数据类型

schema

discount

固定折扣使用保存值

body

false

number

discountModel

折扣模式

body

false

string

discountType

折扣类型(金额;%)

body

false

string

rangeDiscounts

折扣价格区间

body

false

array

RangeVo

rangeValueType

区间值类型

body

false

string

响应状态

状态码

说明

schema

200

OK

ResponseData«ChargeVO»

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

ChargeVo

ChargeVo

message

状态描述信息

string

success

是否成功

响应示例

{
  "code": 200,
  "data": {
    "id": 15902039404039940000,
    "name": "年费",
    "chargeType": "年",
    "minTerm": 1,
    "maxTerm": 100,
    "chargePrice": {
      "chargeModel": "固定定价",
      "listPrice": 100,
      "rangePriceType": "单价",
      "rangePrices": [
        {
          "rangeNo": 1,
          "rangeFrom": 1,
          "rangeTo": "1,000",
          "price": 5
        }
      ],
      "cost": 60,
      "commissionRate": 0.03,
      "uom": "天",
      "minQty": 1,
      "maxQty": "1,000"
    },
    "hasDiscount": true,
    "discount": {
      "discountModel": "固定折扣",
      "discountType": "金额",
      "discount": 100,
      "rangeValueType": "数量",
      "rangeDiscounts": [
        {
          "rangeNo": 1,
          "rangeFrom": 1,
          "rangeTo": "1,000",
          "price": 5
        }
      ]
    },
    "createdBy": "Ella",
    "createdOn": "2022-08-01 18:43:25",
    "lastUpdatedBy": "Michael",
    "lastUpdatedOn": "2022-08-10 13:22:12"
  },
  "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
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
49
json

GET 获取产品明细项

接口地址 /bee/api/v1/product-charges/{charge-id}

请求方式 GET

consumes ``

produces ["*/*"]

接口描述 ``

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

charge-id

charge-id

path

true

string

响应状态

状态码

说明

schema

200

OK

ResponseData«ChargeVo»

401

Unauthorized

403

Forbidden

404

Not Found

响应参数

参数名称

参数说明

类型

schema

code

响应状态码

integer(int32)

integer(int32)

data

通用返回数据

ChargeVo

ChargeVo

message

状态描述信息

string

success

是否成功

boolean

schema属性说明

ChargeVo

参数名称

参数说明

类型

schema

chargePlanId

产品定价计划Id

integer(int64)

chargePrice

价格数据

ChargePriceVo

ChargePriceVo

chargeType

定价周期

string

discount

折扣数据

DiscountPriceVo

DiscountPriceVo

hasDiscount

折扣开启(true;false)

boolean

id

计费项返回id

integer(int64)

maxTerm

最大周期

integer(int32)

minTerm

最小周期

integer(int32)

name

名称

string

productId

产品Id

integer(int64)

taxRateName

税的名称

string

ChargePriceVo

参数名称

参数说明

类型

schema

chargeModel

定价模式

string

commissionRate

佣金率

number

cost

成本

number

listPrice

价格

number

maxQty

最大额度

integer(int32)

minQty

最小额度

integer(int32)

rangePriceType

区间价格

string

rangePrices

价格区间

array

RangeVo

uom

定价单位(固定定价没有)

string

RangeVo

参数名称

参数说明

类型

schema

price

价格

number

rangeFrom

开始区间

number

rangeTo

结束区间

number

DiscountPriceVo

参数名称

参数说明

类型

schema

discount

固定折扣使用保存值

number

discountModel

折扣模式

string

discountType

折扣类型(金额;%)

string

rangeDiscounts

折扣价格区间

array

RangeVo

rangeValueType

区间值类型

string

schema属性说明

创建产品计费明细项

参数名称

参数说明

类型

schema

chargePlanId

产品定价计划Id

integer(int64)

chargePrice

价格数据

ChargePriceVo

ChargePriceVo

chargeType

定价周期

string

discount

折扣数据

DiscountPriceVo

DiscountPriceVo

hasDiscount

折扣开启(true;false)

boolean

id

计费项返回id

integer(int64)

maxTerm

最大周期

integer(int32)

minTerm

最小周期

integer(int32)

name

名称

string

productId

产品Id

integer(int64)

taxRateName

税的名称

string

ChargePriceVo

参数名称

参数说明

类型

schema

chargeModel

定价模式

string

commissionRate

佣金率

number

cost

成本

number

listPrice

价格

number

maxQty

最大额度

integer(int32)

minQty

最小额度

integer(int32)

rangePriceType

区间价格

string

rangePrices

价格区间

array

RangeVo

uom

定价单位(固定定价没有)

string

RangeVo

参数名称

参数说明

类型

schema

price

价格

number

rangeFrom

开始区间

number

rangeTo

结束区间

number

DiscountPriceVo

参数名称

参数说明

类型

schema

discount

固定折扣使用保存值

number

discountModel

折扣模式

string

discountType

折扣类型(金额;%)

string

rangeDiscounts

折扣价格区间

array

RangeVo

rangeValueType

区间值类型

string

响应示例

{
  "code": 200,
  "data": {
    "id": 15902039404039940000,
    "name": "年费",
    "chargeType": "年",
    "minTerm": 1,
    "maxTerm": 100,
    "chargePrice": {
      "chargeModel": "固定定价",
      "listPrice": 100,
      "rangePriceType": "单价",
      "rangePrices": [
        {
          "rangeNo": 1,
          "rangeFrom": 1,
          "rangeTo": "1,000",
          "price": 5
        }
      ],
      "cost": 60,
      "commissionRate": 0.03,
      "uom": "天",
      "minQty": 1,
      "maxQty": "1,000"
    },
    "hasDiscount": true,
    "discount": {
      "discountModel": "固定折扣",
      "discountType": "金额",
      "discount": 100,
      "rangeValueType": "数量",
      "rangeDiscounts": [
        {
          "rangeNo": 1,
          "rangeFrom": 1,
          "rangeTo": "1,000",
          "price": 5
        }
      ]
    },
    "createdBy": "Ella",
    "createdOn": "2022-08-01 18:43:25",
    "lastUpdatedBy": "Michael",
    "lastUpdatedOn": "2022-08-10 13:22:12"
  },
  "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
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
49
json

DELETE 删除产品明细项

接口地址 /bee/api/v1/product-charges/{charge-id}

请求方式 DELETE

consumes ``

produces ["*/*"]

请求参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

charge-id

charge-id

path

true

string

响应状态

状态码

说明

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,
	"data": {},
	"message": "删除成功",
	"success": true
}
1
2
3
4
5
6
json
上一篇
商机 API
下一篇
订阅蜂CPQ解决方案
本篇目录

POST 创建标准产品

PUT 修改产品基本信息

PUT 产品上架

PUT 产品下架

DELETE 删除产品

POST 创建复杂定价产品

GET 查询产品详情

POST 创建产品定价计划

GET 查询产品定价计划

PUT 更新产品定价计划

DELETE 删除定价计划

POST 创建产品明细项

GET 获取产品明细项

DELETE 删除产品明细项