Browse Source

去除更新批次接口,添加修改订单接口代替运单货物相关接口

gmw 5 năm trước cách đây
mục cha
commit
7ebcd36855
1 tập tin đã thay đổi với 115 bổ sung42 xóa
  1. 115 42
      README.md

+ 115 - 42
README.md

@@ -10,14 +10,11 @@
 - [创建订单接口](#创建订单接口)
 - [查询订单接口](#查询订单接口)
 - [批量查询订单接口](#批量查询订单接口)
+- [修改订单接口](#修改订单接口)
 - [撤销订单接口](#撤销订单接口)
 - [创建车次接口](#创建车次接口)
-- [更新批次接口](#更新批次接口)
 - [创建数据看板接口](#创建数据看板接口)
 - [创建数据看板库存接口](#创建数据看板库存接口)
-- [追加订单货物接口](#追加订单货物接口)
-- [修改订单货物接口](#修改订单货物接口)
-- [删除订单货物接口](#删除订单货物接口)
 - [订单订阅接口](#订单订阅接口)
 - [取消订单订阅接口](#取消订单订阅接口)
 - [车次订阅接口](#车次订阅接口)
@@ -417,7 +414,6 @@
                     "id": "5d2c3616b16e6300102d3b3e",
                     "uid": "5d2bd68ae4b0dc3282ebe13e",//主账号id
                     "ttmsOrderId": "5d2c3616b16e6300102d3ab8",//运单id
-                    "number": null, //货物号,即创建订单时的cargoNumber字段
                     "name": "MacBook Pro", //货物名称
                     "quantity": 8, //数量
                     "weight": null, //质量
@@ -702,13 +698,13 @@
 }
 ```
 
-## 撤销订单接口
+## 修改订单接口
 
-**简要描述:** 批量撤销订单,撤销的订单会进入回收站中。只有状态为:待处理,已下单,已接单的运单可以撤销
+**简要描述:** 修改订单,未传递的字段以及值为null的值不进行修改;收货人信息以及货物信息为List类型,修改时会覆盖原本的信息,所以需要将原本的信息和修改的信息合并后进行传递,如果不修改此信息请传递null,如果传递空List会将该信息清空。受理单分段管理中的运单信息继承自受理单,请使用[更新受理单接口](#更新受理单接口)修改
 
-**请求 URL:** `/order/cancel_orders/v2`
+**请求 URL:** `/order/modify_order`
 
-**请求方式:** POST, GET
+**请求方式:** POST
 
 **需要认证:** 是
 
@@ -716,33 +712,40 @@
 
 | 参数名 | 必选 | 类型 | 说明 |
 |:----:|:---:|:-----:|:-----:|
-| `numbers` | 是 | `string` | 订单number列表,多个订单用','隔开 |
+| `orderNumber` | 是 | String | 订单号 |
+| `order` | 是 | [ModifyOrderEntity](#修改运单参数说明) | 修改运单参数 |
 
 **返回示例**
 
+- 调用成功示例
+
 ```java
 {
     "code": 200,
-    "message": null
+    "message": null,
+    "data": true
 }
 ```
 - 调用失败示例
 
 ```java
 {
-    "status": 500,
-    "message": "撤销订单失败原因"
+    "message": "订单号必填",
+    "status": 500
+}
+{
+    "message": "订单xxx不存在",
+    "status": 500
 }
 ```
 
+## 撤销订单接口
 
-## 创建车次接口
-
-**简要描述:** 开单并创建车次
+**简要描述:** 批量撤销订单,撤销的订单会进入回收站中。只有状态为:待处理,已下单,已接单的运单可以撤销
 
-**请求 URL:** `/order/create_order_pack`
+**请求 URL:** `/order/cancel_orders/v2`
 
-**请求方式:** POST
+**请求方式:** POST, GET
 
 **需要认证:** 是
 
@@ -750,21 +753,14 @@
 
 | 参数名 | 必选 | 类型 | 说明 |
 |:----:|:---:|:-----:|:-----:|
-| `orderList` | 是 | Array[[OrderEntity](#运单参数说明)] | 运单列表 |
-| `driverPhone` | 否 | `string` | 司机电话 |
+| `numbers` | 是 | `string` | 订单number列表,多个订单用','隔开 |
 
 **返回示例**
 
-- 调用成功示例
-
 ```java
 {
-    "code":200,
-    "data": {
-        "numbers":["1712051703640558"], // 创建运单号
-        "ids":["5a2660f3d109770010026df9"], // 运单id
-        "packNumber":"P171205558E431E0001" // 车次号
-    }
+    "code": 200,
+    "message": null
 }
 ```
 - 调用失败示例
@@ -772,17 +768,16 @@
 ```java
 {
     "status": 500,
-    "message": "订单车次失败"
+    "message": "撤销订单失败原因"
 }
 ```
 
 
+## 创建车次接口
 
-## 更新批次接口
-
-**简要描述:** 更新批次
+**简要描述:** 开单并创建车次
 
-**请求 URL:** `/order/update_batch`
+**请求 URL:** `/order/create_order_pack`
 
 **请求方式:** POST
 
@@ -792,7 +787,8 @@
 
 | 参数名 | 必选 | 类型 | 说明 |
 |:----:|:---:|:-----:|:-----:|
-| `orderList` | 是 | Array[[OrderEntity](#运单参数说明)] |
+| `orderList` | 是 | Array[[OrderEntity](#运单参数说明)] | 运单列表 |
+| `driverPhone` | 否 | `string` | 司机电话 |
 
 **返回示例**
 
@@ -800,8 +796,12 @@
 
 ```java
 {
-    "code": 200,
-    "message": null
+    "code":200,
+    "data": {
+        "numbers":["1712051703640558"], // 创建运单号
+        "ids":["5a2660f3d109770010026df9"], // 运单id
+        "packNumber":"P171205558E431E0001" // 车次号
+    }
 }
 ```
 - 调用失败示例
@@ -809,11 +809,10 @@
 ```java
 {
     "status": 500,
-    "message": "订单创建失败"
+    "message": "订单车次失败"
 }
 ```
 
-
 ## 创建数据看板接口
 
 **简要描述:** 创建数据看板
@@ -910,7 +909,7 @@
 
 
 
-## 追加订单货物接口
+## 追加订单货物接口(请使用[修改订单接口](#修改订单接口))
 
 **简要描述:** 追加订单货物
 
@@ -952,7 +951,7 @@
 }
 ```
 
-## 修改订单货物接口
+## 修改订单货物接口(请使用[修改订单接口](#修改订单接口))
 
 **简要描述:** 修改订单货物
 
@@ -994,7 +993,7 @@
 ```
 
 
-## 删除订单货物接口
+## 删除订单货物接口(请使用[修改订单接口](#修改订单接口))
 
 **简要描述:** 删除订单货物
 
@@ -1781,7 +1780,6 @@ OrderEntity结构如下:
             note12 (string) //自定义备注12 ,
         }
         cargoList {  //货物列表 (Array[货物请求])
-            cargoNumber (string) //货物编号:用于货物相关接口,需要增/删/改货物的话需要传次字段 ,
             name (string) //货物名称 ,
             note1 (string) //自定义备注1 ,
             note2 (string) //自定义备注2 ,
@@ -1799,6 +1797,81 @@ OrderEntity结构如下:
 }
 ```
 
+#### 修改运单参数说明
+ModifyOrderEntity结构如下:
+```java
+{
+    //预约送达时间,精确到秒的时间戳
+    "appointArriveTime": 1561627095,
+    "customerOrderNumber": "客户单号",
+    //提货时间,精确到秒的时间戳
+    "deliveryTime": 1561627095,
+    //提送类型, 1自提,2送货
+    "deliveryType": 1,
+    "startAddress": "起始地",
+    "endAddress": "目的地",
+    "note": "备注",
+    //此字段请参考TMS三方接口文档常见问题的组织机构相关问题
+    "organizationPath": "组织机构path",
+    //回单数量
+    "receiptCount": 2,
+    //发货人信息
+    "consigner": {
+        "name": "姓名",
+        "phone": "手机号",
+        "address": {
+            "province": "省",
+            "city": "市",
+            "district": "区",
+            "address": "详细地址",
+            "streetNumber": "街道名称",
+            "lat": 0.0, //纬度
+            "lng": 0.0 //精度
+        }
+    },
+    //收货方信息,consignees=null或不传递此字段则不修改,否则会覆盖原本的收货方信息
+    "consignees": [
+        {
+            "name": "姓名",
+            "phone": "手机号",
+            "address": {
+                "province": "省",
+                "city": "市",
+                "district": "区",
+                "address": "详细地址",
+                "streetNumber": "街道名称",
+                "lat": 0.0, //纬度
+                "lng": 0.0 //精度
+            }
+        }
+    ],
+    /*运单自定义备注,只需传递需要修改的备注即可,值为null或者未传递的不会修改
+      目前TMS系统共有12个自定义备注*/
+    "customNotes": {
+        "note1": "自定义备注1",
+        "note2": "自定义备注2",
+        .....
+        "note12": "自定义备注12"
+    },
+    //货物信息列表,orderCargoes=null或不传递此字段则不修改,否则会覆盖原本的货物信息
+    "orderCargoes": [
+        {
+            "name": "货物名称",
+            "quantity": 1.0, //件数
+            "value": 2.0,    //货值
+            "volume": 3.0,   //体积
+            "weight": 4.0,   //重量
+            "productModel": "备注",
+            "note1": "自定义货物备注1",
+            "note2": "自定义货物备注2",
+            "note3": "自定义货物备注3",
+            "note4": "自定义货物备注4",
+            "note5": "自定义货物备注5",
+            "note6": "自定义货物备注6"
+        }
+    ]
+}
+```
 
 #### 受理单参数说明
 CustomerOrderEntity结构如下: