orderApi.md 60 KB
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 /api/blade-factory/api/factory/order
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| size | query | integer | 否 | none |
| current | query | integer | 否 | none |
| Blade-Auth | header | string | 否 | none |
| Authorization | header | string | 否 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
POST 销售订单-添加
POST /api/blade-factory/api/factory/order
Body 请求参数
{
"orderCode": "",
"orgId": "123456789",
"orgCode": "000000",
"orgName": "库比森集团111",
"customerId": "7894587",
"customerCode": "CODE-0000548",
"customerName": "新店营业部",
"orderType": 1,
"totalAmount": 55.55,
"totalQuantity": 8,
"addressId": 88,
"receiverName": "老王",
"receiverPhone": "15002154874",
"receiverAddress": "新厂区",
"receiverRegion": "河南省 焦作市 解放区",
"status": 0
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
| Authorization | header | string | 否 | none |
| body | body | object | 否 | none |
| » orderCode | body | string | 是 | 订单编号(业务唯一标识) |
| » orgId | body | string | 是 | 组织ID(关联来源:zcrm_view_customer_sel.ORG_ID) |
| » orgCode | body | string | 是 | 组织编码 |
| » orgName | body | string | 是 | 组织名称 |
| » customerId | body | string | 是 | 客户ID(关联来源:zcrm_view_customer_sel.Customer_ID) |
| » customerCode | body | string | 是 | 客户编码 |
| » customerName | body | string | 是 | 客户名称 |
| » orderType | body | integer | 是 | 订单类型(1表示普通订单) |
| » totalAmount | body | number | 是 | 订单总金额 |
| » totalQuantity | body | integer | 是 | 订单总数量 |
| » addressId | body | integer | 是 | 收货地址ID(关联pc_blade_customer_address表的id字段) |
| » receiverName | body | string | 是 | 收货人姓名 |
| » receiverPhone | body | string | 是 | 收货人联系电话 |
| » receiverAddress | body | string | 是 | 详细收货地址 |
| » receiverRegion | body | string | 是 | 省市区信息 |
| » status | body | integer | 是 | 订单状态(0:草稿, 1:已提交, 2:已确认, 3:部分发货, 4:已完成, 5:已取消) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
PUT 销售订单-修改
PUT /api/blade-factory/api/factory/order
Body 请求参数
{
"id": 1953347503755579400,
"orderCode": "123456721",
"orgId": "123456789",
"orgCode": "000000",
"orgName": "海尔集团",
"customerId": "7894587",
"customerCode": "CODE-0000548",
"customerName": "新店营业部666",
"orderType": 0,
"totalAmount": 88.1,
"totalQuantity": 11,
"addressId": 6,
"receiverName": "老王321",
"receiverPhone": "15002154874",
"receiverAddress": "新厂区",
"receiverRegion": "河南省 焦作市 解放区",
"status": 0
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
| body | body | object | 否 | none |
| » id | body | integer | 是 | ID |
| » orderCode | body | string | 是 | 订单编号(业务唯一标识) |
| » orgId | body | string | 是 | 组织ID(关联来源:zcrm_view_customer_sel.ORG_ID) |
| » orgCode | body | string | 是 | 组织编码 |
| » orgName | body | string | 是 | 组织名称 |
| » customerId | body | string | 是 | 客户ID(关联来源:zcrm_view_customer_sel.Customer_ID) |
| » customerCode | body | string | 是 | 客户编码 |
| » customerName | body | string | 是 | 客户名称 |
| » orderType | body | integer | 是 | 订单类型(1表示普通订单) |
| » totalAmount | body | number | 是 | 订单总金额 |
| » totalQuantity | body | integer | 是 | 订单总数量 |
| » addressId | body | integer | 是 | 收货地址ID(关联pc_blade_customer_address表的id字段) |
| » receiverName | body | string | 是 | 收货人姓名 |
| » receiverPhone | body | string | 是 | 收货人联系电话 |
| » receiverAddress | body | string | 是 | 详细收货地址 |
| » receiverRegion | body | string | 是 | 省市区信息 |
| » status | body | integer | 是 | 订单状态(0:草稿, 1:已提交, 2:已确认, 3:部分发货, 4:已完成, 5:已取消) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
GET 销售订单-单条分页查询
GET /api/blade-factory/api/factory/order/1953350868828938242
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
后台相关接口/发票明细
GET 发票明细-列表分页查询
GET /api/blade-factory/api/factory/order-invoice-item
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| size | query | integer | 否 | none |
| current | query | integer | 否 | none |
| Blade-Auth | header | string | 否 | token |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
POST 发票明细-添加
POST /api/blade-factory/api/factory/order-invoice-item
Body 请求参数
{
"invoiceId": 10001,
"invoiceNo": "INV20230001",
"orderId": 50001,
"orderItemId": 70001,
"itemId": 30001,
"itemCode": "MAT-001",
"itemName": "不锈钢螺丝",
"specs": "M6×20",
"quantity": 1000,
"unitPrice": 0.5,
"taxRate": 0.13,
"amount": 442.48,
"taxAmount": 57.52,
"totalAmount": 500
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
| body | body | object | 否 | none |
| » invoiceId | body | integer | 是 | 发票ID(关联pc_blade_order_invoice表的id字段) |
| » invoiceNo | body | string | 是 | 发票号码 |
| » orderId | body | integer | 是 | 订单ID(关联销售订单主表ID) |
| » orderItemId | body | integer | 是 | 订单明细ID(关联pc_blade_order_item表的id字段) |
| » itemId | body | integer | 是 | 物料ID(来源:zcrm_view_item_sel.Item_ID) |
| » itemCode | body | string | 是 | 物料编码 |
| » itemName | body | string | 是 | 物料名称 |
| » specs | body | string | 是 | 物料规格 |
| » quantity | body | integer | 是 | 开票数量 |
| » unitPrice | body | number | 是 | 含税单价 |
| » taxRate | body | number | 是 | 税率(如13表示13%) |
| » amount | body | number | 是 | 不含税金额 |
| » taxAmount | body | number | 是 | 税额(税金金额) |
| » totalAmount | body | integer | 是 | 价税合计(不含税金额+税额) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
PUT 发票明细-修改
PUT /api/blade-factory/api/factory/order-invoice-item
Body 请求参数
{
"id": 1,
"invoiceId": 10001,
"invoiceNo": "INV20230001",
"orderId": 50001,
"orderItemId": 70001,
"itemId": 30001,
"itemCode": "MAT-001",
"itemName": "不锈钢螺丝",
"specs": "M6×20",
"quantity": 1000,
"unitPrice": 0.5,
"taxRate": 0.13,
"amount": 442.48,
"taxAmount": 57.52,
"totalAmount": 500
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
| body | body | object | 否 | none |
| » id | body | integer | 是 | ID |
| » invoiceId | body | integer | 是 | 发票ID(关联pc_blade_order_invoice表的id字段) |
| » invoiceNo | body | string | 是 | 发票号码 |
| » orderId | body | integer | 是 | 订单ID(关联销售订单主表ID) |
| » orderItemId | body | integer | 是 | 订单明细ID(关联pc_blade_order_item表的id字段) |
| » itemId | body | integer | 是 | 物料ID(来源:zcrm_view_item_sel.Item_ID) |
| » itemCode | body | string | 是 | 物料编码 |
| » itemName | body | string | 是 | 物料名称 |
| » specs | body | string | 是 | 物料规格 |
| » quantity | body | integer | 是 | 开票数量 |
| » unitPrice | body | number | 是 | 含税单价 |
| » taxRate | body | number | 是 | 税率(如13表示13%) |
| » amount | body | number | 是 | 不含税金额 |
| » taxAmount | body | number | 是 | 税额(税金金额) |
| » totalAmount | body | integer | 是 | 价税合计(不含税金额+税额) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
GET 发票明细-单条分页查询
GET /api/blade-factory/api/factory/order-invoice-item/1
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
后台相关接口/销售订单明细表
GET 销售订单明细 -列表分页查询
GET /api/blade-factory/api/factory/order-item
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| size | query | integer | 否 | none |
| current | query | integer | 否 | none |
| Blade-Auth | header | string | 否 | token |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
POST 销售订单明细-添加
POST /api/blade-factory/api/factory/order-item
Body 请求参数
{
"orderId": 100001,
"orderCode": "SO-20231115-001",
"itemId": 30001,
"itemCode": "MAT-001",
"itemName": "不锈钢螺丝",
"specs": "M6×20",
"mainItemCategoryId": 8001,
"mainItemCategoryName": "五金工具",
"warehouseId": 9001,
"warehouseName": "上海中心仓",
"availableQuantity": 5000,
"orderQuantity": 1000,
"confirmQuantity": 1000,
"unitPrice": 0.55,
"taxRate": 0.13,
"taxAmount": 63.27,
"totalAmount": 550,
"itemStatus": 3
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
| body | body | object | 否 | none |
| » orderId | body | integer | 是 | 订单ID(关联销售订单主表pc_blade_order的id字段) |
| » orderCode | body | string | 是 | 订单编号(关联销售订单的唯一业务编号) |
| » itemId | body | integer | 是 | 物料ID(来源:zcrm_view_item_sel.Item_ID) |
| » itemCode | body | string | 是 | 物料编码(物料的唯一标识编码) |
| » itemName | body | string | 是 | 物料名称(物料的具体名称) |
| » specs | body | string | 是 | 物料规格(物料的型号、参数等规格信息) |
| » mainItemCategoryId | body | integer | 是 | 主分类ID(品牌ID，来源:zcrm_view_item_sel.MainItemCategory_ID) |
| » mainItemCategoryName | body | string | 是 | 主分类名称(品牌名称) |
| » warehouseId | body | integer | 是 | 仓库ID(存储物料的仓库ID，来源:zcrm_view_item_sel.Warehouse_ID) |
| » warehouseName | body | string | 是 | 仓库名称(存储物料的仓库具体名称) |
| » availableQuantity | body | integer | 是 | 可用库存量(当前仓库中该物料的可发货数量) |
| » orderQuantity | body | integer | 是 | 订单数量(该物料的下单数量) |
| » confirmQuantity | body | integer | 是 | 确认数量(已确认的可发货数量) |
| » unitPrice | body | number | 是 | 单价(含税单价，单个物料的含税价格) |
| » taxRate | body | number | 是 | 税率(物料适用的税率，如13表示13%) |
| » taxAmount | body | number | 是 | 税额(该物料的税金金额，根据数量和税率计算) |
| » totalAmount | body | integer | 是 | 行总金额(该物料的总金额，数量×含税单价) |
| » itemStatus | body | integer | 是 | 行状态(0:未确认, 1:已确认, 2:部分发货, 3:已完成) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
PUT 销售订单明细-修改
PUT /api/blade-factory/api/factory/order-item
Body 请求参数
{
"id": 1953377374938534000,
"orderId": 100002,
"orderCode": "SO-20231116-002",
"itemId": 30005,
"itemCode": "MAT-005",
"itemName": "塑料工具箱",
"specs": "大号",
"mainItemCategoryId": 8002,
"mainItemCategoryName": "塑料制品",
"warehouseId": 9002,
"warehouseName": "北京分仓",
"availableQuantity": 50,
"orderQuantity": 10,
"confirmQuantity": 0,
"unitPrice": 120,
"taxRate": 0.09,
"taxAmount": 108,
"totalAmount": 1200,
"itemStatus": 0
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
| body | body | object | 否 | none |
| » id | body | integer | 是 | ID |
| » orderId | body | integer | 是 | 订单ID(关联销售订单主表pc_blade_order的id字段) |
| » orderCode | body | string | 是 | 订单编号(关联销售订单的唯一业务编号) |
| » itemId | body | integer | 是 | 物料ID(来源:zcrm_view_item_sel.Item_ID) |
| » itemCode | body | string | 是 | 物料编码(物料的唯一标识编码) |
| » itemName | body | string | 是 | 物料名称(物料的具体名称) |
| » specs | body | string | 是 | 物料规格(物料的型号、参数等规格信息) |
| » mainItemCategoryId | body | integer | 是 | 主分类ID(品牌ID，来源:zcrm_view_item_sel.MainItemCategory_ID) |
| » mainItemCategoryName | body | string | 是 | 主分类名称(品牌名称) |
| » warehouseId | body | integer | 是 | 仓库ID(存储物料的仓库ID，来源:zcrm_view_item_sel.Warehouse_ID) |
| » warehouseName | body | string | 是 | 仓库名称(存储物料的仓库具体名称) |
| » availableQuantity | body | integer | 是 | 可用库存量(当前仓库中该物料的可发货数量) |
| » orderQuantity | body | integer | 是 | 订单数量(该物料的下单数量) |
| » confirmQuantity | body | integer | 是 | 确认数量(已确认的可发货数量) |
| » unitPrice | body | number | 是 | 单价(含税单价，单个物料的含税价格) |
| » taxRate | body | number | 是 | 税率(物料适用的税率，如13表示13%) |
| » taxAmount | body | number | 是 | 税额(该物料的税金金额，根据数量和税率计算) |
| » totalAmount | body | integer | 是 | 行总金额(该物料的总金额，数量×含税单价) |
| » itemStatus | body | integer | 是 | 行状态(0:未确认, 1:已确认, 2:部分发货, 3:已完成) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
GET 销售订单明细-单条分页查询
GET /api/blade-factory/api/factory/order-item/1953377374938533890
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
后台相关接口/订单发票信息
GET 订单发票信息 -列表分页查询
GET /api/blade-factory/api/factory/order-invoice
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| size | query | integer | 否 | none |
| current | query | integer | 否 | none |
| Blade-Auth | header | string | 否 | token |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
POST 订单发票信息-添加
POST /api/blade-factory/api/factory/order-invoice
Body 请求参数
{
"invoiceNo": "INV2023110001",
"invoiceCode": "144011900111",
"orderId": 100001,
"orderCode": "SO-20231115-001",
"customerId": 2001,
"customerCode": "CUS-001",
"customerName": "上海机械设备有限公司",
"taxNo": "91310115MA1K41XXXX",
"invoiceTitle": "上海机械设备有限公司",
"amount": 8849.56,
"taxAmount": 1150.44,
"totalAmount": 10000,
"invoiceType": "SPECIAL",
"invoiceStatus": 1,
"invoiceDate": "2023-11-20"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
| body | body | object | 否 | none |
| » invoiceNo | body | string | 是 | 发票号码(发票的唯一标识号码) |
| » invoiceCode | body | string | 是 | 发票代码(税务系统分配的发票代码) |
| » orderId | body | integer | 是 | 订单ID(关联销售订单主表pc_blade_order的id字段) |
| » orderCode | body | string | 是 | 订单编号(关联的销售订单业务编号) |
| » customerId | body | integer | 是 | 客户ID(开票对应的客户唯一标识) |
| » customerCode | body | string | 是 | 客户编码(客户的唯一业务编码) |
| » customerName | body | string | 是 | 客户名称(开票对应的客户全称) |
| » taxNo | body | string | 是 | 纳税人识别号(客户的税务登记证号码) |
| » invoiceTitle | body | string | 是 | 发票抬头(发票上显示的购买方名称) |
| » amount | body | number | 是 | 不含税金额(发票的税前金额合计) |
| » taxAmount | body | number | 是 | 税额(发票的税金总金额) |
| » totalAmount | body | integer | 是 | 价税合计(不含税金额与税额的总和) |
| » invoiceType | body | string | 是 | 发票类型(NORMAL:普票, SPECIAL:专票) |
| » invoiceStatus | body | integer | 是 | 发票状态(0:待开票, 1:已开票, 2:已红冲, 3:已作废) |
| » invoiceDate | body | string | 是 | 开票日期(发票开具的日期，格式通常为YYYY-MM-DD) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
PUT 订单发票信息-修改
PUT /api/blade-factory/api/factory/order-invoice
Body 请求参数
{
"id": 1953383908070334500,
"invoiceNo": "INV2023110002",
"invoiceCode": "144011900112",
"orderId": 100002,
"orderCode": "SO-20231116-002",
"customerId": 2002,
"customerCode": "CUS-002",
"customerName": "北京科技发展有限公司",
"taxNo": "91110108MA01JXXXX",
"invoiceTitle": "北京科技发展有限公司",
"amount": 2654.87,
"taxAmount": 238.94,
"totalAmount": 2893.81,
"invoiceType": "NORMAL",
"invoiceStatus": 0,
"invoiceDate": null
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
| body | body | object | 否 | none |
| » invoiceNo | body | string | 是 | 发票号码(发票的唯一标识号码) |
| » invoiceCode | body | string | 是 | 发票代码(税务系统分配的发票代码) |
| » orderId | body | integer | 是 | 订单ID(关联销售订单主表pc_blade_order的id字段) |
| » orderCode | body | string | 是 | 订单编号(关联的销售订单业务编号) |
| » customerId | body | integer | 是 | 客户ID(开票对应的客户唯一标识) |
| » customerCode | body | string | 是 | 客户编码(客户的唯一业务编码) |
| » customerName | body | string | 是 | 客户名称(开票对应的客户全称) |
| » taxNo | body | string | 是 | 纳税人识别号(客户的税务登记证号码) |
| » invoiceTitle | body | string | 是 | 发票抬头(发票上显示的购买方名称) |
| » amount | body | number | 是 | 不含税金额(发票的税前金额合计) |
| » taxAmount | body | number | 是 | 税额(发票的税金总金额) |
| » totalAmount | body | integer | 是 | 价税合计(不含税金额与税额的总和) |
| » invoiceType | body | string | 是 | 发票类型(NORMAL:普票, SPECIAL:专票) |
| » invoiceStatus | body | integer | 是 | 发票状态(0:待开票, 1:已开票, 2:已红冲, 3:已作废) |
| » invoiceDate | body | string | 是 | 开票日期(发票开具的日期，格式通常为YYYY-MM-DD) |
| » id | body | integer | 是 | ID |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
GET 订单发票信息-单条分页查询
GET /api/blade-factory/api/factory/order-invoice/1953383908070334466
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
后台相关接口/订单发货单主表
GET 订单发货单 -列表分页查询
GET /api/blade-factory/api/factory/order-shipment
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| size | query | integer | 否 | none |
| current | query | integer | 否 | none |
| Blade-Auth | header | string | 否 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
POST 订单发货单-添加
POST /api/blade-factory/api/factory/order-shipment
Body 请求参数
{
"shipmentNo": "SH2023110001",
"orderId": 100001,
"orderCode": "SO-20231115-001",
"shipmentDate": "2023-11-25",
"carrierId": 5001,
"carrierName": "顺丰速运",
"trackingNo": "SF1234567890",
"shippingMethod": "快递",
"shipmentStatus": 4,
"totalPackages": 2,
"totalWeight": 12.5,
"totalVolume": 0.15,
"shipperId": 1001,
"shipperName": "张发货"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
| body | body | object | 否 | none |
| » shipmentNo | body | string | 是 | 发货单号(发货单的业务唯一标识编号) |
| » orderId | body | integer | 是 | 订单ID(关联销售订单主表pc_blade_order的id字段) |
| » orderCode | body | string | 是 | 订单编号(关联的销售订单业务编号，冗余存储) |
| » shipmentDate | body | string | 是 | 发货日期(实际发货的日期，格式通常为YYYY-MM-DD) |
| » carrierId | body | integer | 是 | 承运商ID(物流承运商的唯一标识，逻辑外键可扩展) |
| » carrierName | body | string | 是 | 承运商名称(物流承运商的全称，冗余存储) |
| » trackingNo | body | string | 是 | 物流单号(承运商提供的物流跟踪编号) |
| » shippingMethod | body | string | 是 | 运输方式(如：快递、陆运、空运、海运等) |
| » shipmentStatus | body | integer | 是 | 发货状态(0:待发货, 1:已发货, 2:运输中, 3:已送达, 4:已签收, 5:异常) |
| » totalPackages | body | integer | 是 | 总包裹数(本次发货的包裹总数量) |
| » totalWeight | body | number | 是 | 总重量(本次发货的货物总重量，单位：kg) |
| » totalVolume | body | number | 是 | 总体积(本次发货的货物体积总和，单位：m³) |
| » shipperId | body | integer | 是 | 发货人用户ID(操作发货的用户唯一标识) |
| » shipperName | body | string | 是 | 发货人姓名(操作发货的人员姓名) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
PUT 订单发货单-修改
PUT /api/blade-factory/api/factory/order-shipment
Body 请求参数
{
"id": 1953389102569062400,
"shipmentNo": "SH2023110002",
"orderId": 100002,
"orderCode": "SO-20231116-002",
"shipmentDate": "2023-11-26",
"carrierId": 5002,
"carrierName": "德邦物流",
"trackingNo": "DB9876543210",
"shippingMethod": "陆运",
"shipmentStatus": 2,
"totalPackages": 5,
"totalWeight": 86.3,
"totalVolume": 1.2,
"shipperId": 1002,
"shipperName": "李物流"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
| body | body | object | 否 | none |
| » id | body | integer | 是 | ID |
| » shipmentNo | body | string | 是 | 发货单号(发货单的业务唯一标识编号) |
| » orderId | body | integer | 是 | 订单ID(关联销售订单主表pc_blade_order的id字段) |
| » orderCode | body | string | 是 | 订单编号(关联的销售订单业务编号，冗余存储) |
| » shipmentDate | body | string | 是 | 发货日期(实际发货的日期，格式通常为YYYY-MM-DD) |
| » carrierId | body | integer | 是 | 承运商ID(物流承运商的唯一标识，逻辑外键可扩展) |
| » carrierName | body | string | 是 | 承运商名称(物流承运商的全称，冗余存储) |
| » trackingNo | body | string | 是 | 物流单号(承运商提供的物流跟踪编号) |
| » shippingMethod | body | string | 是 | 运输方式(如：快递、陆运、空运、海运等) |
| » shipmentStatus | body | integer | 是 | 发货状态(0:待发货, 1:已发货, 2:运输中, 3:已送达, 4:已签收, 5:异常) |
| » totalPackages | body | integer | 是 | 总包裹数(本次发货的包裹总数量) |
| » totalWeight | body | number | 是 | 总重量(本次发货的货物总重量，单位：kg) |
| » totalVolume | body | number | 是 | 总体积(本次发货的货物体积总和，单位：m³) |
| » shipperId | body | integer | 是 | 发货人用户ID(操作发货的用户唯一标识) |
| » shipperName | body | string | 是 | 发货人姓名(操作发货的人员姓名) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
GET 订单发货单-单条分页查询
GET /api/blade-factory/api/factory/order-shipment/1953389102569062401
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
后台相关接口/发货单明细表
GET 发货单明细表 -列表分页查询
GET /api/blade-factory/api/factory/shipment-item
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| size | query | integer | 否 | none |
| current | query | integer | 否 | none |
| Blade-Auth | header | string | 否 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
PUT 发货单明细表-修改
PUT /api/blade-factory/api/factory/shipment-item
Body 请求参数
{
"id": 1953392654498533400,
"shipmentId": 7001,
"shipmentNo": "SH2023110001",
"orderId": 100001,
"orderItemId": 7102,
"itemId": 30002,
"itemCode": "MAT-002",
"itemName": "铝合金支架",
"specs": "50×50×3mm",
"shippedQuantity": 150,
"packageNo": "PKG-002",
"batchNo": "B20231102"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
| body | body | object | 否 | none |
| » id | body | number | 是 | 发货单明细ID(主键，唯一标识一条发货明细记录) |
| » shipmentId | body | integer | 是 | 发货单ID(关联发货单主表pc_blade_order_shipment的id字段) |
| » shipmentNo | body | string | 是 | 发货单号(关联的发货单业务编号，冗余存储) |
| » orderId | body | integer | 是 | 订单ID(关联销售订单主表pc_blade_order的id字段) |
| » orderItemId | body | integer | 是 | 订单明细ID(关联销售订单明细表pc_blade_order_item的id字段) |
| » itemId | body | integer | 是 | 物料ID(来源:zcrm_view_item_sel.Item_ID，对应发货的物料唯一标识) |
| » itemCode | body | string | 是 | 物料编码(发货物料的唯一业务编码) |
| » itemName | body | string | 是 | 物料名称(发货物料的具体名称) |
| » specs | body | string | 是 | 物料规格(发货物料的型号、参数等规格信息) |
| » shippedQuantity | body | integer | 是 | 本次发货数量(该物料在当前发货单中的实际发货数量) |
| » packageNo | body | string | 是 | 包裹编号(多包裹发货场景下，该物料所在包裹的标识) |
| » batchNo | body | string | 是 | 批次号/序列号(物料的生产批次或唯一序列号，用于溯源) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
POST 发货单明细表-添加
POST /api/blade-factory/api/factory/shipment-item
Body 请求参数
{
"shipmentId": 7001,
"shipmentNo": "SH2023110001",
"orderId": 100001,
"orderItemId": 7101,
"itemId": 30001,
"itemCode": "MAT-001",
"itemName": "不锈钢螺丝",
"specs": "M6×20",
"shippedQuantity": 500,
"packageNo": "PKG-001",
"batchNo": "B20231101"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
| body | body | object | 否 | none |
| » id | body | number | 是 | 发货单明细ID(主键，唯一标识一条发货明细记录) |
| » shipmentId | body | integer | 是 | 发货单ID(关联发货单主表pc_blade_order_shipment的id字段) |
| » shipmentNo | body | string | 是 | 发货单号(关联的发货单业务编号，冗余存储) |
| » orderId | body | integer | 是 | 订单ID(关联销售订单主表pc_blade_order的id字段) |
| » orderItemId | body | integer | 是 | 订单明细ID(关联销售订单明细表pc_blade_order_item的id字段) |
| » itemId | body | integer | 是 | 物料ID(来源:zcrm_view_item_sel.Item_ID，对应发货的物料唯一标识) |
| » itemCode | body | string | 是 | 物料编码(发货物料的唯一业务编码) |
| » itemName | body | string | 是 | 物料名称(发货物料的具体名称) |
| » specs | body | string | 是 | 物料规格(发货物料的型号、参数等规格信息) |
| » shippedQuantity | body | integer | 是 | 本次发货数量(该物料在当前发货单中的实际发货数量) |
| » packageNo | body | string | 是 | 包裹编号(多包裹发货场景下，该物料所在包裹的标识) |
| » batchNo | body | string | 是 | 批次号/序列号(物料的生产批次或唯一序列号，用于溯源) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
GET 发货单明细表-单条分页查询
GET /api/blade-factory/api/factory/shipment-item/1953392654498533378
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
后台相关接口/物流跟踪信息表
GET 物流跟踪信息表 -列表分页查询
GET /api/blade-factory/api/factory/shipment-tracking
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| size | query | integer | 否 | none |
| current | query | integer | 否 | none |
| Blade-Auth | header | string | 否 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
PUT 物流跟踪信息表-修改
PUT /api/blade-factory/api/factory/shipment-tracking
Body 请求参数
{
"id": 1953396644422598700,
"shipmentId": 7002,
"shipmentNo": "SH2023110002",
"trackingNo": "DB9876543210",
"trackingStatus": "运输中",
"location": "北京市大兴区物流中转中心",
"eventTime": "2023-11-27 09:15:00",
"eventDesc": "货物已离开天津分拨中心，前往北京",
"isException": 0,
"exceptionType": null
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
| body | body | object | 否 | none |
| » id | body | number | 是 | 物流跟踪记录ID(主键，唯一标识一条物流跟踪信息) |
| » shipmentId | body | integer | 是 | 发货单ID(关联发货单主表pc_blade_order_shipment的id字段) |
| » shipmentNo | body | string | 是 | 发货单号(关联的发货单业务编号，冗余存储) |
| » trackingNo | body | string | 是 | 物流单号(承运商提供的物流跟踪编号，用于查询物流状态) |
| » trackingStatus | body | string | 是 | 物流状态(如：已揽收、运输中、派送中、已签收等) |
| » location | body | string | 是 | 当前位置描述(物流事件发生的地点，如“北京市朝阳区快递点”) |
| » eventTime | body | string | 是 | 事件时间(物流状态发生的时间，格式通常为YYYY-MM-DD HH:mm:ss) |
| » eventDesc | body | string | 是 | 事件描述(对物流状态的详细说明，如“快递已由[张三]签收”) |
| » isException | body | integer | 是 | 是否异常(0:否, 1:是，标识当前物流状态是否存在异常) |
| » exceptionType | body | null | 是 | 异常类型(当is_exception=1时有效，如“破损、丢失、延迟”等；无异常时可为null) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
POST 物流跟踪信息表-添加
POST /api/blade-factory/api/factory/shipment-tracking
Body 请求参数
{
"shipmentId": 7001,
"shipmentNo": "SH2023110001",
"trackingNo": "SF1234567890",
"trackingStatus": "已签收",
"location": "上海市浦东区张江高科技园区",
"eventTime": "2023-11-28 15:30:00",
"eventDesc": "客户已签收，签收人：前台代收",
"isException": 0,
"exceptionType": null
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
| body | body | object | 否 | none |
| » shipmentId | body | integer | 是 | 发货单ID(关联发货单主表pc_blade_order_shipment的id字段) |
| » shipmentNo | body | string | 是 | 发货单号(关联的发货单业务编号，冗余存储) |
| » trackingNo | body | string | 是 | 物流单号(承运商提供的物流跟踪编号，用于查询物流状态) |
| » trackingStatus | body | string | 是 | 物流状态(如：已揽收、运输中、派送中、已签收等) |
| » location | body | string | 是 | 当前位置描述(物流事件发生的地点，如“北京市朝阳区快递点”) |
| » eventTime | body | string | 是 | 事件时间(物流状态发生的时间，格式通常为YYYY-MM-DD HH:mm:ss) |
| » eventDesc | body | string | 是 | 事件描述(对物流状态的详细说明，如“快递已由[张三]签收”) |
| » isException | body | integer | 是 | 是否异常(0:否, 1:是，标识当前物流状态是否存在异常) |
| » exceptionType | body | null | 是 | 异常类型(当is_exception=1时有效，如“破损、丢失、延迟”等；无异常时可为null) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
GET 物流跟踪信息表-单条分页查询
GET /api/blade-factory/api/factory/shipment-tracking/1953396644422598657
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
后台相关接口/客户收货地址表
GET 物流跟踪信息表 -列表分页查询 Copy
GET /api/blade-factory/api/factory/address
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| size | query | integer | 否 | none |
| current | query | integer | 否 | none |
| Blade-Auth | header | string | 否 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
POST 物流跟踪信息表-添加 Copy
POST /api/blade-factory/api/factory/address
Body 请求参数
{
"customerId": 2001,
"customerCode": "CUS-001",
"customerName": "上海机械设备有限公司",
"receiverName": "王经理",
"receiverPhone": "13800138001",
"regionCode": "310115",
"regionName": "上海市 浦东新区",
"detailAddress": "张江高科技园区科苑路88号2号楼501室",
"postalCode": "201203",
"isDefault": 1,
"isActive": 1
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
| body | body | object | 否 | none |
| » customerId | body | integer | 是 | 客户ID(关联来源：zcrm_view_customer_sel.Customer_ID，对应所属客户的唯一标识) |
| » customerCode | body | string | 是 | 客户编码(所属客户的唯一业务编码) |
| » customerName | body | string | 是 | 客户名称(所属客户的全称) |
| » receiverName | body | string | 是 | 收货人姓名(接收货物的联系人姓名) |
| » receiverPhone | body | string | 是 | 收货人联系电话(接收货物的联系人电话，用于物流沟通) |
| » regionCode | body | string | 是 | 地区编码(国家标准行政区划代码，标识省市区层级信息) |
| » regionName | body | string | 是 | 省市区文本(地区编码对应的省、市、区全称，如“北京市海淀区”) |
| » detailAddress | body | string | 是 | 详细地址(具体的街道、门牌号等详细位置信息) |
| » postalCode | body | string | 是 | 邮政编码(收货地址对应的邮政区划编码) |
| » isDefault | body | integer | 是 | 是否默认地址(0:否, 1:是，标识该地址是否为客户的默认收货地址) |
| » isActive | body | integer | 是 | 是否有效(0:无效, 1:有效，标识该地址是否可用，无效地址将不参与业务流程) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
PUT 物流跟踪信息表-修改 Copy
PUT /api/blade-factory/api/factory/address
Body 请求参数
{
"id": 1953399699591385000,
"customerId": 2002,
"customerCode": "CUS-002",
"customerName": "北京科技发展有限公司",
"receiverName": "李主任",
"receiverPhone": "13900139002",
"regionCode": "110108",
"regionName": "北京市 海淀区",
"detailAddress": "中关村南大街5号理工科技大厦8层",
"postalCode": "100081",
"isDefault": 0,
"isActive": 1
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
| body | body | object | 否 | none |
| » id | body | number | 是 | 地址记录ID(主键，唯一标识一条客户收货地址记录) |
| » customerId | body | integer | 是 | 客户ID(关联来源：zcrm_view_customer_sel.Customer_ID，对应所属客户的唯一标识) |
| » customerCode | body | string | 是 | 客户编码(所属客户的唯一业务编码) |
| » customerName | body | string | 是 | 客户名称(所属客户的全称) |
| » receiverName | body | string | 是 | 收货人姓名(接收货物的联系人姓名) |
| » receiverPhone | body | string | 是 | 收货人联系电话(接收货物的联系人电话，用于物流沟通) |
| » regionCode | body | string | 是 | 地区编码(国家标准行政区划代码，标识省市区层级信息) |
| » regionName | body | string | 是 | 省市区文本(地区编码对应的省、市、区全称，如“北京市海淀区”) |
| » detailAddress | body | string | 是 | 详细地址(具体的街道、门牌号等详细位置信息) |
| » postalCode | body | string | 是 | 邮政编码(收货地址对应的邮政区划编码) |
| » isDefault | body | integer | 是 | 是否默认地址(0:否, 1:是，标识该地址是否为客户的默认收货地址) |
| » isActive | body | integer | 是 | 是否有效(0:无效, 1:有效，标识该地址是否可用，无效地址将不参与业务流程) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
GET 物流跟踪信息表-单条分页查询 Copy
GET /api/blade-factory/api/factory/address/1953399699591385090
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
业务相关接口/销售订单
GET 获取下单人收获地址列表----接口
GET /api/blade-factory/api/factory/salesOrder/getAddressList
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Blade-Auth | header | string | 否 | token |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
POST 添加收货地址
POST /api/blade-factory/api/factory/salesOrder/addAddress
Body 请求参数
{
"customerId": 123456,
"customerCode": "CUST001",
"customerName": "张三有限公司",
"receiverName": "李四",
"receiverPhone": "13800138000",
"regionCode": "110108",
"regionName": "北京市海淀区",
"detailAddress": "中关村大街1号创新大厦B座501室",
"postalCode": "100080",
"isDefault": 1,
"isActive": 1
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| Blade-Auth | header | string | 否 | token | |
| body | body | object | 否 | none | |
| » customerId | body | integer | 是 | 客户 ID（关联客户表） | none |
| » customerCode | body | string | 是 | 客户编码 | none |
| » customerName | body | string | 是 | 客户名称 | none |
| » receiverName | body | string | 是 | 收货人姓名（必填） | none |
| » receiverPhone | body | string | 是 | 收货人联系电话（必填） | none |
| » regionCode | body | string | 是 | 地区编码（国家标准，如行政区划代码） | none |
| » regionName | body | string | 是 | 省市区文本（如 "北京市海淀区"） | none |
| » detailAddress | body | string | 是 | 详细地址信息（必填） | none |
| » postalCode | body | string | 是 | 邮政编码（可选） | none |
| » isDefault | body | integer | 是 | 是否默认地址（0 - 否，1 - 是） | none |
| » isActive | body | integer | 是 | 是否有效 0无效 1有效 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
PUT 修改收获地址
PUT /api/blade-factory/api/factory/salesOrder/updateAddress
Body 请求参数
{
"id": 1003,
"customerId": 789012,
"customerCode": "CUST002",
"customerName": "王五贸易公司",
"receiverName": "赵六六",
"receiverPhone": "13700137000",
"regionCode": "310104",
"regionName": "上海市徐汇区",
"detailAddress": "淮海中路1000号",
"postalCode": "200030",
"isDefault": 0,
"isActive": 1
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| Blade-Auth | header | string | 否 | token | |
| body | body | object | 否 | none | |
| » id | body | integer¦null | 是 | ID | none |
| » customerId | body | integer | 是 | 客户 ID（关联客户表） | none |
| » customerCode | body | string | 是 | 客户编码 | none |
| » customerName | body | string | 是 | 客户名称 | none |
| » receiverName | body | string | 是 | 收货人姓名（必填） | none |
| » receiverPhone | body | string | 是 | 收货人联系电话（必填） | none |
| » regionCode | body | string | 是 | 地区编码（国家标准，如行政区划代码） | none |
| » regionName | body | string | 是 | 省市区文本（如 "北京市海淀区"） | none |
| » detailAddress | body | string | 是 | 详细地址信息（必填） | none |
| » postalCode | body | string | 是 | 邮政编码（可选） | none |
| » isDefault | body | integer | 是 | 是否默认地址（0 - 否，1 - 是） | none |
| » isActive | body | integer | 是 | 是否有效 0无效 1有效 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
PUT 单独修改地址的默认状态
PUT /api/blade-factory/api/factory/salesOrder/setDefaultAddress
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| addressId | query | string | 否 | ID | |
| Blade-Auth | header | string | 否 | token |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
DELETE 删除指定地址
DELETE /api/blade-factory/api/factory/salesOrder/deleteAddress
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| addressId | query | integer | 否 | ID | |
| Blade-Auth | header | string | 否 | token |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
GET 检查库存--仓库库存列表-列表分页查询
GET /api/blade-factory/api/factory/salesOrder/whqoh/list
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| size | query | integer | 否 | none | |
| current | query | integer | 否 | none | |
| Blade-Auth | header | string | 否 | token |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
GET 检查库存--仓库库存列表-查询一条数据
GET /api/blade-factory/api/factory/salesOrder/whqoh/1953022847472451585
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| Blade-Auth | header | string | 否 | token |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
GET 料品档案--料品档案列表-列表分页查询
GET /api/blade-factory/api/factory/salesOrder/item/list
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| size | query | integer | 否 | none | |
| current | query | integer | 否 | none | |
| Blade-Auth | header | string | 否 | token |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
GET 料品档案--料品档案列表-单条分页查询
GET /api/blade-factory/api/factory/salesOrder/item/1953022755889823748
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| Blade-Auth | header | string | 否 | token |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
GET 检查库存--仓库库存列表-不分页
GET /api/blade-factory/api/factory/salesOrder/whqoh/fullList
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| Blade-Auth | header | string | 否 | token |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
GET 料品档案--料品档案列表-不分页
GET /api/blade-factory/api/factory/salesOrder/item/fullList
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| Blade-Auth | header | string | 否 | token |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
POST 销售订单明细-添加
POST /api/blade-factory/api/factory/salesOrder/addOrderItem
Body 请求参数
{
"orderId": 100001,
"orderCode": "SO-20231115-001",
"itemId": 30001,
"itemCode": "MAT-001",
"itemName": "不锈钢螺丝",
"specs": "M6×20",
"mainItemCategoryId": 8001,
"mainItemCategoryName": "五金工具",
"warehouseId": 9001,
"warehouseName": "上海中心仓",
"availableQuantity": 5000,
"orderQuantity": 1000,
"confirmQuantity": 1000,
"unitPrice": 0.55,
"taxRate": 0.13,
"taxAmount": 63.27,
"totalAmount": 550,
"itemStatus": 3
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none | |
| body | body | object | 否 | none | |
| » orderId | body | integer | 是 | 订单ID(关联销售订单主表pc_blade_order的id字段) | |
| » orderCode | body | string | 是 | 订单编号(关联销售订单的唯一业务编号) | |
| » itemId | body | integer | 是 | 物料ID(来源:zcrm_view_item_sel.Item_ID) | |
| » itemCode | body | string | 是 | 物料编码(物料的唯一标识编码) | |
| » itemName | body | string | 是 | 物料名称(物料的具体名称) | |
| » specs | body | string | 是 | 物料规格(物料的型号、参数等规格信息) | |
| » mainItemCategoryId | body | integer | 是 | 主分类ID(品牌ID，来源:zcrm_view_item_sel.MainItemCategory_ID) | |
| » mainItemCategoryName | body | string | 是 | 主分类名称(品牌名称) | |
| » warehouseId | body | integer | 是 | 仓库ID(存储物料的仓库ID，来源:zcrm_view_item_sel.Warehouse_ID) | |
| » warehouseName | body | string | 是 | 仓库名称(存储物料的仓库具体名称) | |
| » availableQuantity | body | integer | 是 | 可用库存量(当前仓库中该物料的可发货数量) | |
| » orderQuantity | body | integer | 是 | 订单数量(该物料的下单数量) | |
| » confirmQuantity | body | integer | 是 | 确认数量(已确认的可发货数量) | |
| » unitPrice | body | number | 是 | 单价(含税单价，单个物料的含税价格) | |
| » taxRate | body | number | 是 | 税率(物料适用的税率，如13表示13%) | |
| » taxAmount | body | number | 是 | 税额(该物料的税金金额，根据数量和税率计算) | |
| » totalAmount | body | integer | 是 | 行总金额(该物料的总金额，数量×含税单价) | |
| » itemStatus | body | integer | 是 | 行状态(0:未确认, 1:已确认, 2:部分发货, 3:已完成) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
PUT 销售订单明细-修改
PUT /api/blade-factory/api/factory/salesOrder/updateOrderItem
Body 请求参数
{
"id": 1953377374938534000,
"orderId": 100002,
"orderCode": "SO-20231116-002",
"itemId": 30005,
"itemCode": "MAT-005",
"itemName": "塑料工具箱",
"specs": "大号",
"mainItemCategoryId": 8002,
"mainItemCategoryName": "塑料制品",
"warehouseId": 9002,
"warehouseName": "北京分仓",
"availableQuantity": 50,
"orderQuantity": 10,
"confirmQuantity": 0,
"unitPrice": 120,
"taxRate": 0.09,
"taxAmount": 108,
"totalAmount": 1200,
"itemStatus": 0
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none | |
| body | body | object | 否 | none | |
| » id | body | integer | 是 | ID | |
| » orderId | body | integer | 是 | 订单ID(关联销售订单主表pc_blade_order的id字段) | |
| » orderCode | body | string | 是 | 订单编号(关联销售订单的唯一业务编号) | |
| » itemId | body | integer | 是 | 物料ID(来源:zcrm_view_item_sel.Item_ID) | |
| » itemCode | body | string | 是 | 物料编码(物料的唯一标识编码) | |
| » itemName | body | string | 是 | 物料名称(物料的具体名称) | |
| » specs | body | string | 是 | 物料规格(物料的型号、参数等规格信息) | |
| » mainItemCategoryId | body | integer | 是 | 主分类ID(品牌ID，来源:zcrm_view_item_sel.MainItemCategory_ID) | |
| » mainItemCategoryName | body | string | 是 | 主分类名称(品牌名称) | |
| » warehouseId | body | integer | 是 | 仓库ID(存储物料的仓库ID，来源:zcrm_view_item_sel.Warehouse_ID) | |
| » warehouseName | body | string | 是 | 仓库名称(存储物料的仓库具体名称) | |
| » availableQuantity | body | integer | 是 | 可用库存量(当前仓库中该物料的可发货数量) | |
| » orderQuantity | body | integer | 是 | 订单数量(该物料的下单数量) | |
| » confirmQuantity | body | integer | 是 | 确认数量(已确认的可发货数量) | |
| » unitPrice | body | number | 是 | 单价(含税单价，单个物料的含税价格) | |
| » taxRate | body | number | 是 | 税率(物料适用的税率，如13表示13%) | |
| » taxAmount | body | number | 是 | 税额(该物料的税金金额，根据数量和税率计算) | |
| » totalAmount | body | integer | 是 | 行总金额(该物料的总金额，数量×含税单价) | |
| » itemStatus | body | integer | 是 | 行状态(0:未确认, 1:已确认, 2:部分发货, 3:已完成) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
PUT 销售订单-修改-修改订单
PUT /api/blade-factory/api/factory/salesOrder/updateOrder
Body 请求参数
{
"id": 1953347503755579400,
"orderId": 100001,
"orderCode": "123456721",
"orgId": "123456789",
"orgCode": "000000",
"orgName": "海尔集团",
"customerId": "7894587",
"customerCode": "CODE-0000548",
"customerName": "新店营业部666",
"orderType": 0,
"totalAmount": 88.1,
"totalQuantity": 11,
"addressId": 6,
"receiverName": "老王321",
"receiverPhone": "15002154874",
"receiverAddress": "新厂区",
"receiverRegion": "河南省 焦作市 解放区",
"pcBladeOrderItemList": [
{
"orderId": 100001,
"orderCode": "SO-20231115-001",
"itemId": 30001,
"itemCode": "MAT-001",
"itemName": "不锈钢螺丝",
"specs": "M6×20",
"mainItemCategoryId": 8001,
"mainItemCategoryName": "五金工具",
"warehouseId": 9001,
"warehouseName": "上海中心仓",
"availableQuantity": 5000,
"orderQuantity": 1000,
"confirmQuantity": 1000,
"unitPrice": 0.55,
"taxRate": 0.13,
"taxAmount": 63.27,
"totalAmount": 550,
"itemStatus": 3
},
{
"orderId": 100001,
"orderCode": "SO-20231115-001",
"itemId": 30001,
"itemCode": "MAT-001",
"itemName": "不锈钢螺丝",
"specs": "M6×20",
"mainItemCategoryId": 8001,
"mainItemCategoryName": "五金工具",
"warehouseId": 9001,
"warehouseName": "上海中心仓",
"availableQuantity": 5000,
"orderQuantity": 1000,
"confirmQuantity": 1000,
"unitPrice": 0.55,
"taxRate": 0.13,
"taxAmount": 63.27,
"totalAmount": 550,
"itemStatus": 3
}
],
"status": 0
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| Blade-Auth | header | string | 否 | none | |
| body | body | object | 否 | none | |
| » id | body | integer | 是 | ID | |
| » orderCode | body | string | 是 | 订单编号(业务唯一标识) | |
| » orgId | body | string | 是 | 组织ID(关联来源:zcrm_view_customer_sel.ORG_ID) | |
| » orgCode | body | string | 是 | 组织编码 | |
| » orgName | body | string | 是 | 组织名称 | |
| » customerId | body | string | 是 | 客户ID(关联来源:zcrm_view_customer_sel.Customer_ID) | |
| » customerCode | body | string | 是 | 客户编码 | |
| » customerName | body | string | 是 | 客户名称 | |
| » orderType | body | integer | 是 | 订单类型(1表示普通订单) | |
| » totalAmount | body | number | 是 | 订单总金额 | |
| » totalQuantity | body | integer | 是 | 订单总数量 | |
| » addressId | body | integer | 是 | 收货地址ID(关联pc_blade_customer_address表的id字段) | |
| » receiverName | body | string | 是 | 收货人姓名 | |
| » receiverPhone | body | string | 是 | 收货人联系电话 | |
| » receiverAddress | body | string | 是 | 详细收货地址 | |
| » receiverRegion | body | string | 是 | 省市区信息 | |
| » status | body | integer | 是 | 订单状态(0:草稿, 1:已提交, 2:已确认, 3:部分发货, 4:已完成, 5:已取消) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
返回数据结构
POST 销售订单-添加-创建订单
POST /api/blade-factory/api/factory/salesOrder/addOrder
Body 请求参数
{
"orgId": "123456789",
"orgCode": "000000",
"orgName": "海尔集团",
"customerId": "7894587",
"customerCode": "CODE-0000548",
"customerName": "新店营业部666",
"orderType": 0,
"totalAmount": 88.1,
"totalQuantity": 11,
"addressId": 6,
"receiverName": "老王321",
"receiverPhone": "15002154874",
"receiverAddress": "新厂区",
"receiverRegion": "河南省 焦作市 解放区",
"pcBladeOrderItemList": [
{
"itemId": 30001,
"itemCode": "MAT-001",
"itemName": "不锈钢螺丝",
"specs": "M6×20",
"mainItemCategoryId": 8001,
"mainItemCategoryName": "五金工具",
"warehouseId": 9001,
"warehouseName": "上海中心仓",
"availableQuantity": 5000,
"orderQuantity": 1000,
"confirmQuantity": 1000,
"unitPrice": 0.55,
"taxRate": 0.13,
"taxAmount": 63.27,
"totalAmount": 550,
"itemStatus": 3
},
{
"itemId": 30001,
"itemCode": "MAT-001",
"itemName": "不锈钢螺丝",
"specs": "M6×20",
"mainItemCategoryId": 8001,
"mainItemCategoryName": "五金工具",
"warehouseId": 9001,
"warehouseName": "上海中心仓",
"availableQuantity": 5000,
"orderQuantity": 1000,
"confirmQuantity": 1000,
"unitPrice": 0.55,
"taxRate": 0.13,
"taxAmount": 63.27,
"totalAmount": 550,
"itemStatus": 3
}
],
"status": 0
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| Blade-Auth | header | string | 否 | token | |
| body | body | object | 否 | none | |
| » id | body | integer | 是 | ID | |
| » orderCode | body | string | 是 | 订单编号(业务唯一标识) | |
| » orgId | body | string | 是 | 组织ID(关联来源:zcrm_view_customer_sel.ORG_ID) | |
| » orgCode | body | string | 是 | 组织编码 | |
| » orgName | body | string | 是 | 组织名称 | |
| » customerId | body | string | 是 | 客户ID(关联来源:zcrm_view_customer_sel.Customer_ID) | |
| » customerCode | body | string | 是 | 客户编码 | |
| » customerName | body | string | 是 | 客户名称 | |
| » orderType | body | integer | 是 | 订单类型(1表示普通订单) | |
| » totalAmount | body | number | 是 | 订单总金额 | |
| » totalQuantity | body | integer | 是 | 订单总数量 | |
| » addressId | body | integer | 是 | 收货地址ID(关联pc_blade_customer_address表的id字段) | |
| » receiverName | body | string | 是 | 收货人姓名 | |
| » receiverPhone | body | string | 是 | 收货人联系电话 | |
| » receiverAddress | body | string | 是 | 详细收货地址 | |
| » receiverRegion | body | string | 是 | 省市区信息 | |
| » status | body | integer | 是 | 订单状态(0:草稿, 1:已提交, 2:已确认, 3:部分发货, 4:已完成, 5:已取消) |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |