增加获取和删除发货计划的 API。

1 year ago · f9cb8359c0
2 changed files with 169 additions and 0 deletions
--- a/wms/发货通知/LeaptonDeleteDeliveryPlan.md
+++ 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": {}
+}
+```
+
--- a/wms/发货通知/LeaptonGetDeliveryPlan.md
+++ 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
+  }
+}
+```