调整目录

README.md

@@ -2,31 +2,46 @@
 
 ------
 
-- [接口简介(**请仔细阅读!**)](#接口简介)
-- [接口说明](#接口说明)
-- **[常见问题指南(有问题先看这!)](PROBLEMS.md)**
-- [获取登陆凭证接口](#获取登陆凭证接口)
-- [更新登陆凭证接口](#更新登陆凭证接口)
-- [创建订单接口](#创建订单接口)
-- [查询订单接口](#查询订单接口)
-- [批量查询订单接口](#批量查询订单接口)
-- [修改订单接口](#修改订单接口)
-- [撤销订单接口](#撤销订单接口)
-- [创建车次接口](#创建车次接口)
-- [订单订阅接口](#订单订阅接口)
-- [取消订单订阅接口](#取消订单订阅接口)
-- [车次订阅接口](#车次订阅接口)
-- [取消车次订阅接口](#取消车次订阅接口)
-- [获取组织机构列表接口](#获取组织机构列表接口)
-- [添加客户接口](#添加客户接口)
-- [创建受理单接口](#创建受理单接口)
-- [更新受理单接口](#更新受理单接口)
-- [批量查询受理单接口](#批量查询受理单接口)
-- [撤销受理单接口](#撤销受理单接口)
-- [批量解绑受理单设备](#批量解绑受理单设备)
+<!-- TOC -->
+
+- [TMS/CTMS第三方接口文档](#tmsctms第三方接口文档)
+    - [接口简介](#接口简介)
+    - [接口说明](#接口说明)
+- [接口凭证](#接口凭证)
+    - [获取登陆凭证接口](#获取登陆凭证接口)
+    - [更新登陆凭证接口](#更新登陆凭证接口)
+- [运单类接口](#运单类接口)
+    - [创建订单接口](#创建订单接口)
+    - [查询订单接口](#查询订单接口)
+    - [批量查询订单接口](#批量查询订单接口)
+    - [修改订单接口](#修改订单接口)
+    - [撤销订单接口](#撤销订单接口)
+    - [订单货物类接口](#订单货物类接口)
+            - [追加订单货物接口](#追加订单货物接口)
+            - [修改订单货物接口](#修改订单货物接口)
+            - [删除订单货物接口](#删除订单货物接口)
+- [车次类接口](#车次类接口)
+    - [创建车次接口](#创建车次接口)
+- [订阅类接口](#订阅类接口)
+    - [订单订阅接口](#订单订阅接口)
+    - [取消订单订阅接口](#取消订单订阅接口)
+    - [车次订阅接口](#车次订阅接口)
+    - [取消车次订阅接口](#取消车次订阅接口)
+- [受理单类接口](#受理单类接口)
+    - [创建受理单接口](#创建受理单接口)
+    - [更新受理单接口](#更新受理单接口)
+    - [批量查询受理单接口](#批量查询受理单接口)
+    - [撤销受理单接口](#撤销受理单接口)
+    - [批量解绑受理单设备](#批量解绑受理单设备)
+- [其他接口](#其他接口)
+    - [获取组织机构列表接口](#获取组织机构列表接口)
+    - [添加客户接口](#添加客户接口)
 - [部分参数说明](#部分参数说明)
-- [错误码说明](#错误码说明)
+    - [运单参数说明](#运单参数说明)
+    - [修改运单参数说明](#修改运单参数说明)
+    - [受理单参数说明](#受理单参数说明)
 
+<!-- /TOC -->
 
 ## 接口简介
 
@@ -62,6 +77,7 @@
 - **message**：错误信息，当接口调用失败（状态码为 非200）时，返回的错误信息
 - **data**：返回数据，接口调用成功（状态码为 200）之后返回的数据
 
+# 接口凭证
 
 ## 获取登陆凭证接口
 
@@ -144,6 +160,7 @@
 }
 ```
 
+# 运单类接口
 
 ## 创建订单接口
 
@@ -770,12 +787,13 @@
 }
 ```
 
+## 订单货物类接口
 
-## 创建车次接口
+#### 追加订单货物接口
 
-**简要描述：** 开单并创建车次
+**简要描述：** 追加订单货物，请使用[修改订单接口](#修改订单接口)
 
-**请求 URL：** `/order/create_order_pack`
+**请求 URL：** `/cargo/add`
 
 **请求方式：** POST
 
@@ -785,8 +803,14 @@
 
 | 参数名 | 必选 | 类型 | 说明 |
 |:----:|:---:|:-----:|:-----:|
-| `orderList` | 是 | Array[[OrderEntity](#运单参数说明)] | 运单列表 |
-| `driverPhone` | 否 | `string` | 司机电话 |
+| `orderNumber` | 是 | `String` | 订单号，客户单号或wms单号  |
+| `cargoNumber` | 是 | `String` | 货物号  |
+| `weight` | 否 | `String` | 重量  |
+| `volume` | 否 | `String` | 体积  |
+| `quantity` | 否 | `String` | 件数  |
+| `value` | 否 | `String` | 货值  |
+| `name` | 否 | `String` | 货物名称  |
+| `productModel` | 否 | `String` | 货物备注  |
 
 **返回示例**
 
@@ -794,12 +818,8 @@
 
 ```java
 {
-    "code":200,
-    "data": {
-        "numbers":["1712051703640558"], // 创建运单号
-        "ids":["5a2660f3d109770010026df9"], // 运单id
-        "packNumber":"P171205558E431E0001" // 车次号
-    }
+    "code": 200,
+    "message": null
 }
 ```
 - 调用失败示例
@@ -807,15 +827,15 @@
 ```java
 {
     "status": 500,
-    "message": "订单车次失败"
+    "message": "创建失败"
 }
 ```
 
-## 追加订单货物接口(请使用[修改订单接口](#修改订单接口))
+#### 修改订单货物接口
 
-**简要描述：** 追加订单货物
+**简要描述：** 修改订单货物，请使用[修改订单接口](#修改订单接口)
 
-**请求 URL：** `/cargo/add`
+**请求 URL：** `/cargo/update`
 
 **请求方式：** POST
 
@@ -825,7 +845,6 @@
 
 | 参数名 | 必选 | 类型 | 说明 |
 |:----:|:---:|:-----:|:-----:|
-| `orderNumber` | 是 | `String` | 订单号，客户单号或wms单号  |
 | `cargoNumber` | 是 | `String` | 货物号  |
 | `weight` | 否 | `String` | 重量  |
 | `volume` | 否 | `String` | 体积  |
@@ -853,11 +872,12 @@
 }
 ```
 
-## 修改订单货物接口(请使用[修改订单接口](#修改订单接口))
 
-**简要描述：** 修改订单货物
+#### 删除订单货物接口
 
-**请求 URL：** `/cargo/update`
+**简要描述：** 删除订单货物，请使用[修改订单接口](#修改订单接口)
+
+**请求 URL：** `/cargo/remove`
 
 **请求方式：** POST
 
@@ -868,12 +888,6 @@
 | 参数名 | 必选 | 类型 | 说明 |
 |:----:|:---:|:-----:|:-----:|
 | `cargoNumber` | 是 | `String` | 货物号  |
-| `weight` | 否 | `String` | 重量  |
-| `volume` | 否 | `String` | 体积  |
-| `quantity` | 否 | `String` | 件数  |
-| `value` | 否 | `String` | 货值  |
-| `name` | 否 | `String` | 货物名称  |
-| `productModel` | 否 | `String` | 货物备注  |
 
 **返回示例**
 
@@ -882,7 +896,7 @@
 ```java
 {
     "code": 200,
-    "message": null
+    "message": "true"
 }
 ```
 - 调用失败示例
@@ -890,16 +904,17 @@
 ```java
 {
     "status": 500,
-    "message": "创建失败"
+    "message": "false"
 }
 ```
 
+# 车次类接口
 
-## 删除订单货物接口(请使用[修改订单接口](#修改订单接口))
+## 创建车次接口
 
-**简要描述：** 删除订单货物
+**简要描述：** 开单并创建车次
 
-**请求 URL：** `/cargo/remove`
+**请求 URL：** `/order/create_order_pack`
 
 **请求方式：** POST
 
@@ -909,7 +924,8 @@
 
 | 参数名 | 必选 | 类型 | 说明 |
 |:----:|:---:|:-----:|:-----:|
-| `cargoNumber` | 是 | `String` | 货物号  |
+| `orderList` | 是 | Array[[OrderEntity](#运单参数说明)] | 运单列表 |
+| `driverPhone` | 否 | `string` | 司机电话 |
 
 **返回示例**
 
@@ -917,8 +933,12 @@
 
 ```java
 {
-    "code": 200,
-    "message": "true"
+    "code":200,
+    "data": {
+        "numbers":["1712051703640558"], // 创建运单号
+        "ids":["5a2660f3d109770010026df9"], // 运单id
+        "packNumber":"P171205558E431E0001" // 车次号
+    }
 }
 ```
 - 调用失败示例
@@ -926,10 +946,11 @@
 ```java
 {
     "status": 500,
-    "message": "false"
+    "message": "订单车次失败"
 }
 ```
 
+# 订阅类接口
 
 ## 订单订阅接口
 
@@ -1150,123 +1171,7 @@
 }
 ```
 
-## 获取组织机构列表接口
-
-**简要描述：** 获取组织机构列表
-
-**请求 URL：** `/organization/list`
-
-**请求方式：** POST
-
-**需要认证：** 是
-
-**请求参数：**
-
-| 参数名 | 必选 | 类型 | 说明 |
-|:----:|:---:|:-----:|:-----:|
-
-**返回示例**
-
-- 调用成功示例
-
-```java
-{
-    "code":200,
-    "message":null,
-    "data":[
-        {
-            "nodeId":0,
-            "name":"总部",
-            "path":"0-0"
-        },
-        {
-            "nodeId":11,
-            "name":"网点1",
-            "path":"0-11"
-        },
-        {
-            "nodeId":12,
-            "name":"杭州网点2",
-            "path":"0-12"
-        }
-    ]
-}
-```
-- 调用失败示例
-
-```java
-{
-    "status": 500,
-    "message": ""
-}
-```
-
-**对象说明：**
-```java
-{
-    Integer nodeId; // 机构节点id
-    String name; // 机构名
-    String path; // 父节点路径
-}
-```
-
-## 添加客户接口
-
-**简要描述：** 在同一种客户类型中：如果客户电话已存在，则进行更新，否则进行创建。
-
-**请求 URL：** `/customer/add_customers`
-
-**请求方式：** POST
-
-**需要认证：** 是
-
-**请求参数：**
-
-| 参数名 | 必选 | 类型 | 说明 |
-|:----:|:---:|:-----:|:-----:|
-| `customers` | 是 | `Array[CustomerEntity]` | 客户列表 |
-
-其中CustomerEntity结构如下:
-```java
-{
-        String name; //客户名称:必填
-    
-        String phone; //客户电话:必填
-    
-        String address; //客户地址:必填
-    
-        int type; //客户类型:必填 1发货人，2收货人
-    
-        int paymentType; //支付方式:必填 1现付 2到付 3回付 4周结 5月结 6货款扣 7季度结
-    
-        String remark1; //备注1:非必填
-    
-        String remark2; //备注2:非必填
-    
-        String remark3; //备注3:非必填
-}
-```
-
-**返回示例**
-
-- 调用成功示例
-
-```java
-{
-    "code":200,
-    "message":null,
-    "data": true
-}
-```
-- 调用失败示例
-
-```java
-{
-    "status": 500,
-    "message": ""
-}
-```
-
+# 受理单类接口
 
 ## 创建受理单接口
 
@@ -1657,10 +1562,129 @@
 }
 ```
 
+# 其他接口
+
+## 获取组织机构列表接口
+
+**简要描述：** 获取组织机构列表
+
+**请求 URL：** `/organization/list`
+
+**请求方式：** POST
+
+**需要认证：** 是
+
+**请求参数：**
+
+| 参数名 | 必选 | 类型 | 说明 |
+|:----:|:---:|:-----:|:-----:|
+
+**返回示例**
 
-## 部分参数说明
+- 调用成功示例
 
-#### 运单参数说明
+```java
+{
+    "code":200,
+    "message":null,
+    "data":[
+        {
+            "nodeId":0,
+            "name":"总部",
+            "path":"0-0"
+        },
+        {
+            "nodeId":11,
+            "name":"网点1",
+            "path":"0-11"
+        },
+        {
+            "nodeId":12,
+            "name":"杭州网点2",
+            "path":"0-12"
+        }
+    ]
+}
+```
+- 调用失败示例
+
+```java
+{
+    "status": 500,
+    "message": ""
+}
+```
+
+**对象说明：**
+```java
+{
+    Integer nodeId; // 机构节点id
+    String name; // 机构名
+    String path; // 父节点路径
+}
+```
+
+## 添加客户接口
+
+**简要描述：** 在同一种客户类型中：如果客户电话已存在，则进行更新，否则进行创建。
+
+**请求 URL：** `/customer/add_customers`
+
+**请求方式：** POST
+
+**需要认证：** 是
+
+**请求参数：**
+
+| 参数名 | 必选 | 类型 | 说明 |
+|:----:|:---:|:-----:|:-----:|
+| `customers` | 是 | `Array[CustomerEntity]` | 客户列表 |
+
+其中CustomerEntity结构如下:
+```java
+{
+        String name; //客户名称:必填
+    
+        String phone; //客户电话:必填
+    
+        String address; //客户地址:必填
+    
+        int type; //客户类型:必填 1发货人，2收货人
+    
+        int paymentType; //支付方式:必填 1现付 2到付 3回付 4周结 5月结 6货款扣 7季度结
+    
+        String remark1; //备注1:非必填
+    
+        String remark2; //备注2:非必填
+    
+        String remark3; //备注3:非必填
+}
+```
+
+**返回示例**
+
+- 调用成功示例
+
+```java
+{
+    "code":200,
+    "message":null,
+    "data": true
+}
+```
+- 调用失败示例
+
+```java
+{
+    "status": 500,
+    "message": ""
+}
+```
+
+
+# 部分参数说明
+
+## 运单参数说明
 OrderEntity结构如下:
 ```java
 {
@@ -1734,7 +1758,7 @@ OrderEntity结构如下:
 }
 ```
 
-#### 修改运单参数说明
+## 修改运单参数说明
 ModifyOrderEntity结构如下:
 ```java
 {
@@ -1810,7 +1834,7 @@ ModifyOrderEntity结构如下:
 }
 ```
 
-#### 受理单参数说明
+## 受理单参数说明
 CustomerOrderEntity结构如下:
 ```java
 {
@@ -1870,26 +1894,3 @@ CustomerOrderEntity结构如下:
         }
 }
 ```
-
-
-## 错误码说明
-
-| 错误码 |  说明 |
-|:----:|:---:|
-|200|成功|
-|401|授权失败|
-|404| 接口不存在|
-|10011| 提货时间必填|
-|10012| 发货人姓名必填|
-|10013| 发货人手机必填|
-|10014| 发货人地址必填|
-|10015| 发货人城市必填|
-|10016| 城市或地址有误|
-|10017| 收货人姓名必填|
-|10018| 收货人手机必填|
-|10019| 收货人地址必填|
-|10020| 收货人城市必填|
-|10021| 订单号必填|
-|10022| 批次号必填|
-|10023| 订单创建失败|
-|10024| 传入订单列表不能为空|