diff --git a/wms/仓库库位/删除仓库库位.md b/wms/仓库库位/删除仓库库位.md new file mode 100644 index 0000000..a91c514 --- /dev/null +++ b/wms/仓库库位/删除仓库库位.md @@ -0,0 +1,61 @@ +### 添加仓库库位 +此接口用于向WMS删除仓库和库位 +此接口需要认证,详情请查看《认证方式》。 + +--- + +### 基本信息 +方法:POST +URL: http://localhost:8033/open/DeleteStockOrLocation + +--- + +### 请求 + +__请求参数__ + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | String | 是 | 厂区| +| code | String | 是 | 仓库编码、库位名称 | +| type | String | 是 | 类型: STOCK:仓库,LOC:库位 | + + + +__请求示例:__ +``` +{ + "data":{ + "profile": "测试", + "code":"CPC1" + "type":"STOCK" + } +} +```` + +--- + +### 响应 +__响应字段__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| clock | string | 当前服务器时钟。 | +| status | string | 状态,ok:成功,error:错误,exception:异常 | +| data | object | 成功后返回具体内容 | + +__data:__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data": { + + } +} + +``` + + diff --git a/wms/仓库库位/添加仓库库位.md b/wms/仓库库位/添加仓库库位.md new file mode 100644 index 0000000..e22ca67 --- /dev/null +++ b/wms/仓库库位/添加仓库库位.md @@ -0,0 +1,86 @@ +### 添加仓库库位 +此接口用于向WMS添加仓库和库位 +此接口需要认证,详情请查看《认证方式》。 + +--- + +### 基本信息 +方法:POST +URL: http://localhost:8033/open/AddStockAndLocation + +--- + +### 请求 + +__请求参数__ + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | String | 是 | 厂区| +| stocks | Array | 是 | 仓库数组 | +| locations | Array | 是 | 库位数组 | + + +__stocks:__ +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| code | String | 是 | 仓库代码 | +| name | String | 是 | 仓库名称 | +| type | String | 是 | 仓库类型 YLC:原料仓,CPC:成品仓,XBC:线边仓 | + +__locations:__ +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| stockCode | String | 是 | 所属仓库代码 | +| name | String | 是 | 库位名称 | +| fullNumber | long | 否 | 库位满库数量 默认9999 | + +__请求示例:__ +``` +{ + "data":{ + "profile": "测试", + "stocks":[ + { + "code":"CPC1", + "name":"成品仓1", + "type":"CPC" + } + ] + "locations":[ + { + "stockCode":"CPC1", + "name":"CPC1-001", + "fullNumber":360 + } + ] + } +} +```` + +--- + +### 响应 +__响应字段__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| clock | string | 当前服务器时钟。 | +| status | string | 状态,ok:成功,error:错误,exception:异常 | +| data | object | 成功后返回具体内容 | + +__data:__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data": { + + } +} + +``` + + diff --git a/wms/发货通知/LeaptonAddDeliveryPlan.md b/wms/发货通知/LeaptonAddDeliveryPlan.md new file mode 100644 index 0000000..a1c3e51 --- /dev/null +++ b/wms/发货通知/LeaptonAddDeliveryPlan.md @@ -0,0 +1,174 @@ +### LeaptonAddDeliveryPlan + +此接口用于添加发货计划。 + +--- + +### 基本信息 + +方法:POST + +URL: http://localhost:8033/open/leaptonAddDeliveryPlan + +--- + +### 请求 + +请求参数 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | string | 是 | 厂区代码 | +| billType | string | 否 | 单据类型 手选 | +| planner | string | 否 | 计划员 创建人 | +| maker | string | 否 | 制单人 创建人 | +| sourceType | string | 否 | 来源类型 销售订单 | +| billCode | string | 否 | 出货计划单据号 | +| orderCode | string | 否 | 来源单号 销售订单号 | +| lines | array | 是 | 行记录 | + +行记录参数 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| lineNum | long | 是 | ERP 行号
此参数无效时视为 0。 | +| customer | string | 否 | 订货客户 来源销售订单 | +| receivingLocation | string | 否 | 收货位置 来源客户 | +| matCode | string | 否 | 料号 来源销售订单 | +| matName | string | 否 | 品名 来源销售订单 | +| qty | double | 是 | 数量 来源销售订单
保留 6 位有效小数,此参数无效时视为 0。 | +| unit | string | 否 | 单位 来源销售订单 | +| dispatchingDate | string | 否 | 出货日期 单据默认日期可修改 | +| storageLocation | string | 否 | 存储地点 来源销售订单 | +| detailBillCode | string | 否 | 明细行来源单号 来源销售订单 | +| totalPrice | double | 是 | 价税合计 来源销售订单
保留 6 位有效小数,此参数无效时视为 0。 | +| untaxedPrice | double | 是 | 未税金额 来源销售订单
保留 6 位有效小数,此参数无效时视为 0。 | +| unitPrice | double | 是 | 单价 来源销售订单
保留 6 位有效小数,此参数无效时视为 0。 | + +请求示例 + +``` +{ + "data": { + "profile": "profile", + "billType": "", + "planner": "", + "maker": "", + "sourceType": "", + "billCode": "", + "orderCode": "", + "lines": [ + { + "lineNum": 0, + "customer": "", + "receivingLocation": "", + "matCode": "", + "matName": "", + "qty": 1, + "unit": "", + "dispatchingDate": "", + "storageLocation": "", + "detailBillCode": "", + "totalPrice": 1, + "untaxedPrice": 1, + "unitPrice": 1 + }, + { + "lineNum": 0, + "customer": "", + "receivingLocation": "", + "matCode": "", + "matName": "", + "qty": 2, + "unit": "", + "dispatchingDate": "", + "storageLocation": "", + "detailBillCode": "", + "totalPrice": 3, + "untaxedPrice": 3, + "unitPrice": 1.5 + }, + ] + } +} +``` + +--- + +### 响应 + +保存成功时,服务端将返回此条记录,和记录的主键。 + +新增的字段: + +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| key | string | 主键,由系统自动生成。 | +| headKey | string | 主记录的主键,由系统自动填写。 | +| lineIndex | integer | 行索引,由系统自动填写,从 0 开始。 | + +``` +{ + "clock": "2023-08-22 10:35:47.913", + "duration": "87ms", + "status": "ok", + "data": { + "deleted": null, + "profile": "profile", + "billType": "", + "planner": "", + "maker": "", + "sourceType": "", + "billCode": "", + "orderCode": "", + "lines": [ + { + "headKey": "0b9bed8807a04f678a7ac9761270fffd", + "lineIndex": 0, + "lineNum": 0, + "customer": "", + "receivingLocation": "", + "matCode": "", + "matName": "", + "qty": 1.0, + "unit": "", + "dispatchingDate": "", + "storageLocation": "", + "detailBillCode": "", + "totalPrice": 1.0, + "untaxedPrice": 1.0, + "unitPrice": 1.0, + "created": "2023-08-22 10:35:47.876", + "updated": "2023-08-22 10:35:47.876", + "key": "f1c9f505a3ea4dfb8aa693de23602655", + "flag": 1 + }, + { + "headKey": "0b9bed8807a04f678a7ac9761270fffd", + "lineIndex": 1, + "lineNum": 0, + "customer": "", + "receivingLocation": "", + "matCode": "", + "matName": "", + "qty": 2.0, + "unit": "", + "dispatchingDate": "", + "storageLocation": "", + "detailBillCode": "", + "totalPrice": 3.0, + "untaxedPrice": 3.0, + "unitPrice": 1.5, + "created": "2023-08-22 10:35:47.882", + "updated": "2023-08-22 10:35:47.882", + "key": "4d296cc2907d4919a9e4bfd86d98e3db", + "flag": 1 + } + ], + "created": "2023-08-22 10:35:47.872", + "updated": "2023-08-22 10:35:47.872", + "key": "0b9bed8807a04f678a7ac9761270fffd", + "flag": 1 + } +} +``` \ No newline at end of file diff --git a/wms/发货通知/LeaptonDeleteDeliveryPlan.md b/wms/发货通知/LeaptonDeleteDeliveryPlan.md new file mode 100644 index 0000000..4e2e3e9 --- /dev/null +++ b/wms/发货通知/LeaptonDeleteDeliveryPlan.md @@ -0,0 +1,53 @@ +### LeaptonDeleteDeliveryPlan + +此接口用于删除发货计划。 + +不能删除的情况: +- WMS 已经开始执行这项发货计划 +- 要删除的发货计划不属于当前厂区 + +--- + +### 基本信息 + +方法:POST + +URL: http://localhost:8033/open/leaptonDeleteDeliveryPlan + +--- + +### 请求 + +请求参数 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | string | 是 | 厂区 | +| key | string | 是 | 主键 | + +请求示例 + +``` +{ + "data": { + "profile": "测试", + "key": "0b9bed8807a04f678a7ac9761270fffd" + } +} +``` + +--- + +### 响应 + +此 API 没有返回的数据,只许获取状态即可。执行失败时状态不是 `ok`,会附加 message 字段。 + +``` +{ + "clock": "2023-08-22 16:09:58.294", + "duration": "124ms", + "status": "ok", + "data": {} +} +``` + diff --git a/wms/发货通知/LeaptonGetDeliveryPlan.md b/wms/发货通知/LeaptonGetDeliveryPlan.md new file mode 100644 index 0000000..94f3da8 --- /dev/null +++ b/wms/发货通知/LeaptonGetDeliveryPlan.md @@ -0,0 +1,116 @@ +### LeaptonGetDeliveryPlan + +此接口用于获取发货计划。 + +--- + +### 基本信息 + +方法:GET, POST + +URL: http://localhost:8033/open/leaptonGetDeliveryPlan + +--- + +### 请求 + +请求参数 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| key | string | 是 | 发货记录主键 | + +GET 请求示例 + +``` +/open/leaptonGetDeliveryPlan?key=0b9bed8807a04f678a7ac9761270fffd +``` + +POST 请求示例 + +``` +{ + "data": { + "key": "0b9bed8807a04f678a7ac9761270fffd" + } +} +``` + +--- + +### 响应 + +保存成功时,服务端将返回此条记录,和记录的主键。 + +新增的字段: + +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| key | string | 主键,由系统自动生成。 | +| headKey | string | 主记录的主键,由系统自动填写。 | +| lineIndex | integer | 行索引,由系统自动填写,从 0 开始。 | + +``` +{ + "clock": "2023-08-22 11:26:48.559", + "duration": "112ms", + "status": "ok", + "data": { + "deleted": "", + "profile": "profile", + "billType": "", + "planner": "", + "maker": "", + "sourceType": "", + "billCode": "", + "lines": [ + { + "headKey": "0b9bed8807a04f678a7ac9761270fffd", + "lineIndex": 0, + "lineNum": 0, + "customer": "", + "receivingLocation": "", + "matCode": "", + "matName": "", + "qty": 1.0, + "unit": "", + "dispatchingDate": "", + "storageLocation": "", + "detailBillCode": "", + "totalPrice": 1.0, + "untaxedPrice": 1.0, + "unitPrice": 1.0, + "created": "2023-08-22 10:35:47.876", + "updated": "2023-08-22 10:35:47.876", + "key": "f1c9f505a3ea4dfb8aa693de23602655", + "flag": 1 + }, + { + "headKey": "0b9bed8807a04f678a7ac9761270fffd", + "lineIndex": 1, + "lineNum": 0, + "customer": "", + "receivingLocation": "", + "matCode": "", + "matName": "", + "qty": 2.0, + "unit": "", + "dispatchingDate": "", + "storageLocation": "", + "detailBillCode": "", + "totalPrice": 3.0, + "untaxedPrice": 3.0, + "unitPrice": 1.5, + "created": "2023-08-22 10:35:47.882", + "updated": "2023-08-22 10:35:47.882", + "key": "4d296cc2907d4919a9e4bfd86d98e3db", + "flag": 1 + } + ], + "created": "2023-08-22 10:35:47.872", + "updated": "2023-08-22 10:35:47.872", + "key": "0b9bed8807a04f678a7ac9761270fffd", + "flag": 1 + } +} +``` \ No newline at end of file