docs: 添加经销商销售预测API文档

doc/forecastApi.md

@@ -0,0 +1,753 @@
+---
+title: 库比森
+language_tabs:
+  - shell: Shell
+  - http: HTTP
+  - javascript: JavaScript
+  - ruby: Ruby
+  - python: Python
+  - php: PHP
+  - java: Java
+  - go: Go
+toc_footers: []
+includes: []
+search: true
+code_clipboard: true
+highlight_theme: darkula
+headingLevel: 2
+generator: "@tarslib/widdershins v4.0.30"
+
+---
+
+# 库比森
+
+Base URLs:
+
+# Authentication
+
+# 后台相关接口/经销商销售预测列表
+
+## GET 经销商销售预测列表 -列表分页查询
+
+GET /blade-factory/api/factory/forecast
+
+### 请求参数
+
+|名称|位置|类型|必选|说明|
+|---|---|---|---|---|
+|size|query|integer| 否 |none|
+|current|query|integer| 否 |none|
+|Blade-Auth|header|string| 否 |none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+## PUT 经销商销售预测列表-修改
+
+PUT /blade-factory/api/factory/forecast
+
+> Body 请求参数
+
+```json
+{
+  "id": 1954789198347063300,
+  "forecastCode": "FC-2025-08-002",
+  "year": 2025,
+  "month": 8,
+  "customerId": 1002,
+  "customerCode": "DLR-BJ-002",
+  "customerName": "北京朝阳汽配",
+  "brandId": 2002,
+  "brandCode": "BRD-BSH-001",
+  "brandName": "博世",
+  "itemId": 3002,
+  "itemCode": "BRAKE-0986AB",
+  "itemName": "博世刹车片套装",
+  "specs": "适用于奥迪A4L",
+  "forecastQuantity": 80,
+  "currentInventory": 25,
+  "approvalStatus": 1,
+  "approvedBy": 5001,
+  "approvedName": "张经理",
+  "approvedTime": "2025-08-05 14:30:00"
+}
+```
+
+### 请求参数
+
+|名称|位置|类型|必选|说明|
+|---|---|---|---|---|
+|Blade-Auth|header|string| 否 |none|
+|body|body|object| 否 |none|
+|» id|body|number| 是 |预测记录ID(主键，唯一标识一条经销商销售预测记录)|
+|» forecastCode|body|string| 是 |预测编号(销售预测的业务唯一标识编号)|
+|» year|body|integer| 是 |年份(预测对应的年份，如2025)|
+|» month|body|integer| 是 |月份(预测对应的月份，1-12的整数)|
+|» customerId|body|integer| 是 |经销商ID(提交预测的经销商唯一标识)|
+|» customerCode|body|string| 是 |经销商编码(经销商的唯一业务编码)|
+|» customerName|body|string| 是 |经销商名称(提交预测的经销商全称)|
+|» brandId|body|integer| 是 |品牌ID(预测涉及的产品品牌唯一标识)|
+|» brandCode|body|string| 是 |品牌编码(产品品牌的唯一业务编码)|
+|» brandName|body|string| 是 |品牌名称(预测涉及的产品品牌名称)|
+|» itemId|body|integer| 是 |物料ID(预测涉及的具体产品唯一标识)|
+|» itemCode|body|string| 是 |物料编码(预测产品的唯一业务编码)|
+|» itemName|body|string| 是 |物料名称(预测产品的具体名称)|
+|» specs|body|string| 是 |规格(预测产品的型号、参数等规格信息)|
+|» forecastQuantity|body|integer| 是 |预测销售量(预计该产品在对应年月的销售数量)|
+|» currentInventory|body|integer| 是 |当前库存量(预测时该产品的实际库存数量)|
+|» approvalStatus|body|integer| 是 |审批状态(0:未审批, 1:已通过, 2:已拒绝，标识预测计划的审批结果)|
+|» approvedBy|body|integer| 是 |审批人ID(对预测计划进行审批的用户唯一标识)|
+|» approvedName|body|string| 是 |审批人姓名(执行审批操作的人员姓名)|
+|» approvedTime|body|string| 是 |审批时间(完成预测计划审批的时间，格式通常为YYYY-MM-DD HH:mm:ss)|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+## POST 经销商销售预测列表-添加
+
+POST /blade-factory/api/factory/forecast
+
+> Body 请求参数
+
+```json
+{
+  "forecastCode": "FC-2025-08-001",
+  "year": 2025,
+  "month": 8,
+  "customerId": 1001,
+  "customerCode": "DLR-SH-001",
+  "customerName": "上海浦东轮胎经销商",
+  "brandId": 2001,
+  "brandCode": "BRD-ML-001",
+  "brandName": "米其林",
+  "itemId": 3001,
+  "itemCode": "TYRE-225-65R17",
+  "itemName": "米其林Primacy 4 SUV轮胎",
+  "specs": "225/65R17 102H",
+  "forecastQuantity": 150,
+  "currentInventory": 45,
+  "approvalStatus": 0
+}
+```
+
+### 请求参数
+
+|名称|位置|类型|必选|说明|
+|---|---|---|---|---|
+|Blade-Auth|header|string| 否 |none|
+|body|body|object| 否 |none|
+|» forecastCode|body|string| 是 |预测编号(销售预测的业务唯一标识编号)|
+|» year|body|integer| 是 |年份(预测对应的年份，如2025)|
+|» month|body|integer| 是 |月份(预测对应的月份，1-12的整数)|
+|» customerId|body|integer| 是 |经销商ID(提交预测的经销商唯一标识)|
+|» customerCode|body|string| 是 |经销商编码(经销商的唯一业务编码)|
+|» customerName|body|string| 是 |经销商名称(提交预测的经销商全称)|
+|» brandId|body|integer| 是 |品牌ID(预测涉及的产品品牌唯一标识)|
+|» brandCode|body|string| 是 |品牌编码(产品品牌的唯一业务编码)|
+|» brandName|body|string| 是 |品牌名称(预测涉及的产品品牌名称)|
+|» itemId|body|integer| 是 |物料ID(预测涉及的具体产品唯一标识)|
+|» itemCode|body|string| 是 |物料编码(预测产品的唯一业务编码)|
+|» itemName|body|string| 是 |物料名称(预测产品的具体名称)|
+|» specs|body|string| 是 |规格(预测产品的型号、参数等规格信息)|
+|» forecastQuantity|body|integer| 是 |预测销售量(预计该产品在对应年月的销售数量)|
+|» currentInventory|body|integer| 是 |当前库存量(预测时该产品的实际库存数量)|
+|» approvalStatus|body|integer| 是 |审批状态(0:未审批, 1:已通过, 2:已拒绝，标识预测计划的审批结果)|
+|» approvedBy|body|integer| 是 |审批人ID(对预测计划进行审批的用户唯一标识)|
+|» approvedName|body|string| 是 |审批人姓名(执行审批操作的人员姓名)|
+|» approvedTime|body|string| 是 |审批时间(完成预测计划审批的时间，格式通常为YYYY-MM-DD HH:mm:ss)|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+## GET 经销商销售预测列表-单条分页查询
+
+GET /blade-factory/api/factory/forecast/1954739605689266178
+
+### 请求参数
+
+|名称|位置|类型|必选|说明|
+|---|---|---|---|---|
+|Blade-Auth|header|string| 否 |none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+# 后台相关接口/销售预测汇总列表
+
+## GET 销售预测汇总列表-列表分页查询
+
+GET /blade-factory/api/factory/forecast-summary
+
+### 请求参数
+
+|名称|位置|类型|必选|说明|
+|---|---|---|---|---|
+|size|query|integer| 否 |none|
+|current|query|integer| 否 |none|
+|Blade-Auth|header|string| 否 |none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+## PUT 销售预测汇总列表-修改
+
+PUT /blade-factory/api/factory/forecast-summary
+
+> Body 请求参数
+
+```json
+{
+  "id": 1954819531796865000,
+  "year": 2023,
+  "month": 8,
+  "customerId": 1002,
+  "customerCode": "DLR-BJ-001",
+  "customerName": "北京朝阳轮胎经销商",
+  "brandId": 2002,
+  "brandCode": "BRD-BF-001",
+  "brandName": "普利司通",
+  "itemId": 3003,
+  "itemCode": "TYRE-215-60R16",
+  "itemName": "普利司通Turanza T005轮胎",
+  "specs": "215/60R16",
+  "pattern": "95V",
+  "forecastQuantity": 120,
+  "approvalStatus": 2,
+  "approvedBy": 1002,
+  "approvedName": "李审批",
+  "approvedTime": "2023-07-22 16:45:00"
+}
+```
+
+### 请求参数
+
+|名称|位置|类型|必选|说明|
+|---|---|---|---|---|
+|Blade-Auth|header|string| 否 |none|
+|body|body|object| 否 |none|
+|» id|body|number| 是 |预测汇总ID(主键，唯一标识一条销售预测汇总记录)|
+|» year|body|integer| 是 |年份(预测对应的年份，如2025)|
+|» month|body|integer| 是 |月份(预测对应的月份，1-12的整数)|
+|» customerId|body|integer| 是 |经销商ID(提交销售预测的经销商唯一标识)|
+|» customerCode|body|string| 是 |经销商编码(经销商的唯一业务编码)|
+|» customerName|body|string| 是 |经销商名称(提交预测的经销商全称)|
+|» brandId|body|integer| 是 |品牌ID(预测涉及的产品品牌唯一标识)|
+|» brandCode|body|string| 是 |品牌编码(产品品牌的唯一业务编码)|
+|» brandName|body|string| 是 |品牌名称(预测涉及的产品品牌名称)|
+|» itemId|body|integer| 是 |物料ID(预测涉及的具体产品唯一标识)|
+|» itemCode|body|string| 是 |物料编码(预测产品的唯一业务编码)|
+|» itemName|body|string| 是 |物料名称(预测产品的具体名称)|
+|» specs|body|string| 是 |规格(预测产品的型号、参数等规格信息)|
+|» pattern|body|string| 是 |花纹(产品的花纹类型，多用于轮胎等产品的特性描述)|
+|» forecastQuantity|body|integer| 是 |预测数量(预计该产品在对应年月的销售数量)|
+|» approvalStatus|body|integer| 是 |审批状态(0:未审批, 1:已通过, 2:已拒绝，标识预测汇总的审批结果)|
+|» approvedBy|body|integer| 是 |审批人ID(对预测汇总进行审批的用户唯一标识)|
+|» approvedName|body|string| 是 |审批人姓名(执行审批操作的人员姓名)|
+|» approvedTime|body|string| 是 |审批时间(完成预测汇总审批的时间，格式通常为YYYY-MM-DD HH:mm:ss)|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+## POST 销售预测汇总列表-添加
+
+POST /blade-factory/api/factory/forecast-summary
+
+> Body 请求参数
+
+```json
+{
+  "year": 2023,
+  "month": 10,
+  "customerId": 1003,
+  "customerCode": "DLR-GZ-001",
+  "customerName": "广州天河轮胎经销商",
+  "brandId": 2003,
+  "brandCode": "BRD-GD-001",
+  "brandName": "固特异",
+  "itemId": 3004,
+  "itemCode": "TYRE-245-50R19",
+  "itemName": "固特异Eagle F1轮胎",
+  "specs": "245/50R19",
+  "pattern": "105W",
+  "forecastQuantity": 65,
+  "approvalStatus": 1,
+  "approvedBy": 1003,
+  "approvedName": "王经理",
+  "approvedTime": "2023-09-10 11:20:00"
+}
+```
+
+### 请求参数
+
+|名称|位置|类型|必选|说明|
+|---|---|---|---|---|
+|Blade-Auth|header|string| 否 |none|
+|body|body|object| 否 |none|
+|» year|body|integer| 是 |年份(预测对应的年份，如2025)|
+|» month|body|integer| 是 |月份(预测对应的月份，1-12的整数)|
+|» customerId|body|integer| 是 |经销商ID(提交销售预测的经销商唯一标识)|
+|» customerCode|body|string| 是 |经销商编码(经销商的唯一业务编码)|
+|» customerName|body|string| 是 |经销商名称(提交预测的经销商全称)|
+|» brandId|body|integer| 是 |品牌ID(预测涉及的产品品牌唯一标识)|
+|» brandCode|body|string| 是 |品牌编码(产品品牌的唯一业务编码)|
+|» brandName|body|string| 是 |品牌名称(预测涉及的产品品牌名称)|
+|» itemId|body|integer| 是 |物料ID(预测涉及的具体产品唯一标识)|
+|» itemCode|body|string| 是 |物料编码(预测产品的唯一业务编码)|
+|» itemName|body|string| 是 |物料名称(预测产品的具体名称)|
+|» specs|body|string| 是 |规格(预测产品的型号、参数等规格信息)|
+|» pattern|body|string| 是 |花纹(产品的花纹类型，多用于轮胎等产品的特性描述)|
+|» forecastQuantity|body|integer| 是 |预测数量(预计该产品在对应年月的销售数量)|
+|» approvalStatus|body|integer| 是 |审批状态(0:未审批, 1:已通过, 2:已拒绝，标识预测汇总的审批结果)|
+|» approvedBy|body|integer| 是 |审批人ID(对预测汇总进行审批的用户唯一标识)|
+|» approvedName|body|string| 是 |审批人姓名(执行审批操作的人员姓名)|
+|» approvedTime|body|string| 是 |审批时间(完成预测汇总审批的时间，格式通常为YYYY-MM-DD HH:mm:ss)|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+## GET 销售预测汇总列表-单条分页查询
+
+GET /blade-factory/api/factory/forecast-summary/1954819531796865026
+
+### 请求参数
+
+|名称|位置|类型|必选|说明|
+|---|---|---|---|---|
+|Blade-Auth|header|string| 否 |none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+# 业务相关接口/销售预测/经销商提报
+
+## POST 预测数据填报-添加
+
+POST /blade-factory/api/factory/salesForecastSummary/add
+
+> Body 请求参数
+
+```json
+{
+  "year": 2025,
+  "month": 8,
+  "customerId": 10001,
+  "customerCode": "CUST-2025001",
+  "customerName": "北京测试经销商有限公司",
+  "brandId": 2001,
+  "brandCode": "BRAND-A001",
+  "brandName": "朝阳轮胎",
+  "itemId": 30001,
+  "itemCode": "ITEM-8001",
+  "itemName": "高性能轿车轮胎",
+  "specs": "225/50R17",
+  "pattern": "AS01",
+  "forecastQuantity": 1200,
+  "approvalStatus": 0
+}
+```
+
+### 请求参数
+
+|名称|位置|类型|必选|说明|
+|---|---|---|---|---|
+|Blade-Auth|header|string| 否 |token|
+|body|body|object| 否 |none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+## PUT 预测数据填报-修改
+
+PUT /blade-factory/api/factory/salesForecastSummary/update
+
+> Body 请求参数
+
+```json
+{
+  "id": "1954819531796865034",
+  "year": 2025,
+  "month": 8,
+  "customerId": 10001,
+  "customerCode": "CUST-2025001",
+  "customerName": "北京测试经销商有限公司",
+  "brandId": 2001,
+  "brandCode": "BRAND-A001",
+  "brandName": "朝阳轮胎",
+  "itemId": 30001,
+  "itemCode": "ITEM-8001",
+  "itemName": "高性能轿车轮胎",
+  "specs": "225/50R17",
+  "pattern": "AS01",
+  "forecastQuantity": 1200,
+  "approvalStatus": 0
+}
+```
+
+### 请求参数
+
+|名称|位置|类型|必选|说明|
+|---|---|---|---|---|
+|Blade-Auth|header|string| 否 |token|
+|body|body|object| 否 |none|
+
+> 返回示例
+
+> 405 Response
+
+```json
+{
+  "code": 0,
+  "success": true,
+  "data": null,
+  "msg": "string"
+}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|none|Inline|
+
+### 返回数据结构
+
+状态码 **405**
+
+|名称|类型|必选|约束|中文名|说明|
+|---|---|---|---|---|---|
+|» code|integer|true|none||none|
+|» success|boolean|true|none||none|
+|» data|null|true|none||none|
+|» msg|string|true|none||none|
+
+## POST 预测数据填报-批量添加
+
+POST /blade-factory/api/factory/salesForecastSummary/batchSave
+
+> Body 请求参数
+
+```json
+[
+  {
+    "year": 2025,
+    "month": 8,
+    "customerId": 10001,
+    "customerCode": "CUST-2025001",
+    "customerName": "北京测试经销商有限公司",
+    "brandId": 2001,
+    "brandCode": "BRAND-A001",
+    "brandName": "朝阳轮胎",
+    "itemId": 30001,
+    "itemCode": "ITEM-8001",
+    "itemName": "高性能轿车轮胎",
+    "specs": "225/50R17",
+    "pattern": "AS01",
+    "forecastQuantity": 1200,
+    "approvalStatus": 0
+  },
+  {
+    "year": 2025,
+    "month": 8,
+    "customerId": 10001,
+    "customerCode": "CUST-2025001",
+    "customerName": "北京测试经销商有限公司1",
+    "brandId": 2001,
+    "brandCode": "BRAND-A001",
+    "brandName": "朝阳轮胎",
+    "itemId": 30001,
+    "itemCode": "ITEM-8001",
+    "itemName": "高性能轿车轮胎",
+    "specs": "225/50R17",
+    "pattern": "AS01",
+    "forecastQuantity": 1200,
+    "approvalStatus": 0
+  }
+]
+```
+
+### 请求参数
+
+|名称|位置|类型|必选|说明|
+|---|---|---|---|---|
+|Blade-Auth|header|string| 否 |token|
+|body|body|object| 否 |none|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+## GET 预测数据填报-获取最近的一条预测信息填报
+
+GET /blade-factory/api/factory/salesForecastSummary/latest
+
+### 请求参数
+
+|名称|位置|类型|必选|说明|
+|---|---|---|---|---|
+|Blade-Auth|header|string| 否 |token|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+## GET 预测数据填报-获取列表-分页
+
+GET /blade-factory/api/factory/salesForecastSummary/list
+
+### 请求参数
+
+|名称|位置|类型|必选|说明|
+|---|---|---|---|---|
+|page|query|string| 否 |none|
+|current|query|array[string]| 否 |分组|
+|startMonth|query|string| 否 |none|
+|endMonth|query|string| 否 |none|
+|brandName|query|string| 否 |none|
+|Blade-Auth|header|string| 否 |token|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+## GET 预测数据填报-获取列表-分页-分支
+
+GET /blade-factory/api/factory/salesForecastSummary/page
+
+### 请求参数
+
+|名称|位置|类型|必选|说明|
+|---|---|---|---|---|
+|page|query|string| 否 |none|
+|current|query|array[string]| 否 |分组|
+|startMonth|query|string| 否 |none|
+|endMonth|query|string| 否 |none|
+|brandName|query|string| 否 |none|
+|startDate|query|string| 否 |none|
+|endDate|query|string| 否 |none|
+|Blade-Auth|header|string| 否 |token|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+## GET 预测数据填报-获取所有-按照月份
+
+GET /blade-factory/api/factory/salesForecastSummary/byMonth
+
+### 请求参数
+
+|名称|位置|类型|必选|说明|
+|---|---|---|---|---|
+|year|query|string| 否 |none|
+|month|query|string| 否 |none|
+|Blade-Auth|header|string| 否 |token|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+## GET 预测数据填报-查询数据-查出所有不分页
+
+GET /GET /api/factory/salesForecastSummary/lists
+
+### 请求参数
+
+|名称|位置|类型|必选|说明|
+|---|---|---|---|---|
+|Blade-Auth|header|string| 否 |token|
+
+> 返回示例
+
+> 200 Response
+
+```json
+{}
+```
+
+### 返回结果
+
+|状态码|状态码含义|说明|数据模型|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+### 返回数据结构
+
+# 数据模型
+