更新接口文档

README.md

@@ -32,6 +32,7 @@
 - [撤销受理单接口](#撤销受理单接口)
 - [批量解绑受理单设备](#批量解绑受理单设备)
 - [错误码说明](#错误码说明)
+- [字段说明](#字段说明)
 - [测试代码](#测试代码)
 
 ## 接口简介
@@ -161,71 +162,7 @@
 
 | 参数名 | 必选 | 类型 | 说明 |
 |:----:|:---:|:-----:|:-----:|
-| `orderList` | 是 | `Array[OrderEntity]` | 运单列表 |
-
-```
-其中OrderEntity结构如下:
-OrderEntity {
-        private String batchNumber;//批次号：创建订单可不填，确认批次必填
-        private String orderNumber;//订单号:客户系统和TMS系统中订单关联的唯一依据(必填)
-        private String wmsLocation; //集货位
-        private Integer deliveryTime; //提货时间:时间戳格式(必填)
-        private Integer deliveryType; //提送类型：选填, 1自提，2送货
-        private Integer appointArriveTime; //预约送到时间：时间戳格式，选填
-        private String customerOrderNumber; // 客户单号
-        private String startAddress; // 起始地
-        private String endAddress; // 目的地
-        private String consignerName;//发货人姓名(必填)
-        private String consignerPhone;//发货人电话
-        private String consignerAddress;//发货人地址(必填)
-        private String consignerProvince; // 发货人所在省份
-        private String consignerCity;//发货人所在城市
-        private String consignerDistrict;//发货人所在地区
-        private String consigneeName;//收货人姓名
-        private String consigneePhone;//收货人电话
-        private String consigneeAddress;//收货人地址
-        private String consigneeProvince; // 收货人所在省份
-        private String consigneeCity;//收货人所在城市
-        private String consigneeDistrict;//收货人所在地区
-        private Double shipperPay;//上游运费
-        private Integer shipperPayType; //上游运费支付方式:可不填, 1:现付，2到付，3回付，4周结，5月结，6货款扣，7季度结
-        private Double driverPay; //司机运费
-        private Integer driverPayType; //司机运费支付方式:可不填, 1:现付，2到付，3回付，4周结，5月结，6货款扣，7季度结
-        private Integer receiptCount; //回单数量
-        private Double freightCollect; //代收运费：可不填
-        private Double paymentCollect; //代收货款：可不填
-        private String warehouseCode;//第三方参数:仓库编码
-        private String ownerCode; //第三方参数:货主编码
-        private String scheduleOrderCode; //第三方参数:调度单号
-        private String orderType; //第三方参数:业务类型
-        private String deliveryArea; //第三方参数:配送区域
-        private String omsNumber; //第三方参数:oms订单号
-        private Integer preDeliveryTime; //第三方参数:预约送货时间
-        private String payMode; //第三方参数:付款方式
-        private String note; //备注：可不填
-        private Map<String, Object> extraFields; //备注扩展字端：可不填,key的值对应note1-6
-        private String organizationPath; // 所属组织路径, 可不填
-        private Double lng; //发货人经度
-        private Double lat; //发货人纬度
-        //货物列表
-        private List<CargoRequest> cargoList{
-                private String cargoNumber;//货物编号:用于货物相关接口，需要增/删/改货物的话需要传此字段
-                private String weight;//重量
-                private String volume;//体积
-                private String quantity;//件数
-                private String value;//货值
-                private String status;//货物状态
-                private String name;//货物名称
-                private String productModel;// 货物备注
-                private String note1; // 自定义备注1
-                private String note2; // 自定义备注2
-                private String note3; // 自定义备注3
-                private String note4; // 自定义备注4
-                private String note5; // 自定义备注5
-                private String note6; // 自定义备注6
-        }
-}
-```
+| `orderList` | 是 | Array[[OrderEntity](#运单参数说明)] | 运单列表 |
 
 **返回示例**
 
@@ -233,8 +170,8 @@ OrderEntity {
 
 ```
 {
-	"code": 200,
-	"data": ["1712051703640558"],
+    "code": 200,
+    "data": ["1712051703640558"],
     "message": null
 }
 ```
@@ -242,8 +179,8 @@ OrderEntity {
 
 ```
 {
-	"code": 500,
-	"message": "订单创建失败"
+    "code": 500,
+    "message": "订单创建失败"
 }
 ```
 
@@ -507,7 +444,7 @@ OrderEntity {
 
 ```
 {
-	"code": 200,
+    "code": 200,
     "message": null
 }
 ```
@@ -515,8 +452,8 @@ OrderEntity {
 
 ```
 {
-	"code": 500,
-	"message": "撤销订单失败原因"
+    "code": 500,
+    "message": "撤销订单失败原因"
 }
 ```
 
@@ -540,7 +477,7 @@ OrderEntity {
 
 ```
 {
-	"code": 200,
+    "code": 200,
     "message": null
 }
 ```
@@ -548,14 +485,12 @@ OrderEntity {
 
 ```
 {
-	"code": 500,
-	"message": "撤销订单失败原因"
+    "code": 500,
+    "message": "撤销订单失败原因"
 }
 ```
 
 
-
-
 ## 创建车次接口
 
 **简要描述：** 开单并创建车次
@@ -570,73 +505,9 @@ OrderEntity {
 
 | 参数名 | 必选 | 类型 | 说明 |
 |:----:|:---:|:-----:|:-----:|
-| `orderList` | 是 | `Array[OrderEntity]` | 运单列表 |
+| `orderList` | 是 | Array[[OrderEntity](#运单参数说明)] | 运单列表 |
 | `driverPhone` | 否 | `string` | 司机电话 |
 
-```
-driverPhone; //接单司机，支持批量，多个司机之间用逗号隔开
-orderList{
-        private String batchNumber;//批次号：创建订单可不填，确认批次必填
-        private String orderNumber;//订单号:客户系统和TMS系统中订单关联的唯一依据(必填)
-        private String wmsLocation; //集货位
-        private Integer deliveryTime; //提货时间:时间戳格式(必填)
-        private Integer deliveryType; //提送类型：选填, 1自提，2送货
-        private Integer appointArriveTime; //预约送到时间：时间戳格式，选填
-        private String customerOrderNumber; // 客户单号
-        private String startAddress; // 起始地
-        private String endAddress; // 目的地
-        private String consignerName;//发货人姓名(必填)
-        private String consignerPhone;//发货人电话
-        private String consignerAddress;//发货人地址(必填)
-        private String consignerProvince; // 发货人所在省份
-        private String consignerCity;//发货人所在城市
-        private String consignerDistrict;//发货人所在地区
-        private String consigneeName;//收货人姓名
-        private String consigneePhone;//收货人电话
-        private String consigneeAddress;//收货人地址
-        private String consigneeProvince; // 收货人所在省份
-        private String consigneeCity;//收货人所在城市
-        private String consigneeDistrict;//收货人所在地区
-        private Double shipperPay;//上游运费
-        private Integer shipperPayType; //上游运费支付方式:可不填, 1:现付，2到付，3回付，4周结，5月结，6货款扣，7季度结
-        private Double driverPay; //司机运费
-        private Integer driverPayType; //司机运费支付方式:可不填, 1:现付，2到付，3回付，4周结，5月结，6货款扣，7季度结
-        private Integer receiptCount; //回单数量
-        private Double freightCollect; //代收运费：可不填
-        private Double paymentCollect; //代收货款：可不填
-        private String warehouseCode;//第三方参数:仓库编码
-        private String ownerCode; //第三方参数:货主编码
-        private String scheduleOrderCode; //第三方参数:调度单号
-        private String orderType; //第三方参数:业务类型
-        private String deliveryArea; //第三方参数:配送区域
-        private String omsNumber; //第三方参数:oms订单号
-        private Integer preDeliveryTime; //第三方参数:预约送货时间
-        private String payMode; //第三方参数:付款方式
-        private String note; //备注：可不填
-        private Map<String, Object> extraFields; //备注扩展字端：可不填,key的值对应note1-6
-        private String organizationPath; // 所属组织路径, 可不填
-        private Double lng; //发货人经度
-        private Double lat; //发货人纬度
-        //货物列表
-        private List<CargoRequest> cargoList{
-                private String cargoNumber;//货物编号:用于货物相关接口，需要增/删/改货物的话需要传此字段
-                private String weight;//重量
-                private String volume;//体积
-                private String quantity;//件数
-                private String value;//货值
-                private String status;//货物状态
-                private String name;//货物名称
-                private String productModel;// 货物备注
-                private String note1; // 自定义备注1
-                private String note2; // 自定义备注2
-                private String note3; // 自定义备注3
-                private String note4; // 自定义备注4
-                private String note5; // 自定义备注5
-                private String note6; // 自定义备注6
-        }
-}
-```
-
 **返回示例**
 
 - 调用成功示例
@@ -654,8 +525,8 @@ orderList{
 
 ```
 {
-	"code": 500,
-	"message": "订单车次失败"
+    "code": 500,
+    "message": "订单车次失败"
 }
 ```
 
@@ -675,14 +546,14 @@ orderList{
 
 | 参数名 | 必选 | 类型 | 说明 |
 |:----:|:---:|:-----:|:-----:|
-| `orderList` | 是 | `Array[OrderEntity]` |  |
+| `orderList` | 是 | Array[[OrderEntity](#运单参数说明)] |  |
 **返回示例**
 
 - 调用成功示例
 
 ```
 {
-	"code": 200,
+    "code": 200,
     "message": null
 }
 ```
@@ -690,17 +561,8 @@ orderList{
 
 ```
 {
-	"status": 500,
-	"message": "订单创建失败"
-}
-```
-
-
-**对象说明：**
-
-```
-public class OrderRequest implements Serializable {
-    List<OrderEntity> orderList;
+    "status": 500,
+    "message": "订单创建失败"
 }
 ```
 
@@ -727,7 +589,7 @@ public class OrderRequest implements Serializable {
 
 ```
 {
-	"code": 200,
+    "code": 200,
     "message": null
 }
 ```
@@ -735,8 +597,8 @@ public class OrderRequest implements Serializable {
 
 ```
 {
-	"code": 500,
-	"message": "创建失败"
+    "code": 500,
+    "message": "创建失败"
 }
 ```
 
@@ -762,7 +624,7 @@ public class OrderRequest implements Serializable {
 
 ```
 {
-	"code": 200,
+    "code": 200,
     "message": null
 }
 ```
@@ -770,8 +632,8 @@ public class OrderRequest implements Serializable {
 
 ```
 {
-	"code": 500,
-	"message": "创建失败"
+    "code": 500,
+    "message": "创建失败"
 }
 ```
 
@@ -831,7 +693,7 @@ public class AloginventoryRequest {
 
 ```
 {
-	"code": 200,
+    "code": 200,
     "message": null
 }
 ```
@@ -839,8 +701,8 @@ public class AloginventoryRequest {
 
 ```
 {
-	"code": 500,
-	"message": "创建失败"
+    "code": 500,
+    "message": "创建失败"
 }
 ```
 
@@ -873,7 +735,7 @@ public class AloginventoryRequest {
 
 ```
 {
-	"code": 200,
+    "code": 200,
     "message": null
 }
 ```
@@ -881,8 +743,8 @@ public class AloginventoryRequest {
 
 ```
 {
-	"code": 500,
-	"message": "创建失败"
+    "code": 500,
+    "message": "创建失败"
 }
 ```
 
@@ -909,7 +771,7 @@ public class AloginventoryRequest {
 
 ```
 {
-	"code": 200,
+    "code": 200,
     "message": "true"
 }
 ```
@@ -917,8 +779,8 @@ public class AloginventoryRequest {
 
 ```
 {
-	"code": 500,
-	"message": "false"
+    "code": 500,
+    "message": "false"
 }
 ```
 
@@ -1022,7 +884,7 @@ public class AloginventoryRequest {
 ```
 {
     "code": 500,
-    "message": ""
+    "message": ""    
 }
 ```
 
@@ -1123,7 +985,7 @@ public class AloginventoryRequest {
 {
     "code": 500,
     "message": ""
-}
+}    
 ```
 
 - 车次订阅返回报文：
@@ -1386,8 +1248,8 @@ CustomerOrderEntity {
 
 ```
 {
-	"code": 200,
-	"data": ["S1711151843619482"],
+    "code": 200,
+    "data": ["S1711151843619482"],
     "message": null
 }
 ```
@@ -1395,8 +1257,8 @@ CustomerOrderEntity {
 
 ```
 {
-	"code": 500,
-	"message": "受理单创建失败"
+    "code": 500,
+    "message": "受理单创建失败"
 }
 ```
 
@@ -1423,8 +1285,8 @@ CustomerOrderEntity {
 
 ```
 {
-	"code": 200,
-	"data": null,
+    "code": 200,
+    "data": null,
     "message": null
 }
 ```
@@ -1432,8 +1294,8 @@ CustomerOrderEntity {
 
 ```
 {
-	"code": 500,
-	"message": "受理单创建失败"
+    "code": 500,
+    "message": "受理单创建失败"
 }
 ```
 
@@ -1626,8 +1488,8 @@ CustomerOrderEntity {
 
 ```
 {
-	"status": 500,
-	"message": ""
+    "status": 500,
+    "message": ""
 }
 ```
 
@@ -1652,7 +1514,7 @@ CustomerOrderEntity {
 
 ```
 {
-	"code": 200,
+    "code": 200,
     "message": null
 }
 ```
@@ -1660,8 +1522,8 @@ CustomerOrderEntity {
 
 ```
 {
-	"code": 500,
-	"message": "撤销受理单失败原因"
+    "code": 500,
+    "message": "撤销受理单失败原因"
 }
 ```
 
@@ -1707,6 +1569,72 @@ CustomerOrderEntity {
 }
 ```
 
+## 字段说明
+#### 运单参数说明
+```
+其中OrderEntity结构如下:
+OrderEntity {
+        String batchNumber;//批次号：创建订单可不填，确认批次必填
+        String orderNumber;//订单号:客户系统和TMS系统中订单关联的唯一依据(必填)
+        String wmsLocation; //集货位
+        Integer deliveryTime; //提货时间:时间戳格式(必填)
+        Integer deliveryType; //提送类型：选填, 1自提，2送货
+        Integer appointArriveTime; //预约送到时间：时间戳格式，选填
+        String customerOrderNumber; // 客户单号
+        String startAddress; // 起始地
+        String endAddress; // 目的地
+        String consignerName;//发货人姓名(必填)
+        String consignerPhone;//发货人电话
+        String consignerAddress;//发货人地址(必填)
+        String consignerProvince; // 发货人所在省份
+        String consignerCity;//发货人所在城市
+        String consignerDistrict;//发货人所在地区
+        String consigneeName;//收货人姓名
+        String consigneePhone;//收货人电话
+        String consigneeAddress;//收货人地址
+        String consigneeProvince; // 收货人所在省份
+        String consigneeCity;//收货人所在城市
+        String consigneeDistrict;//收货人所在地区
+        Double shipperPay;//上游运费
+        Integer shipperPayType; //上游运费支付方式:可不填, 1:现付，2到付，3回付，4周结，5月结，6货款扣，7季度结
+        Double driverPay; //司机运费
+        Integer driverPayType; //司机运费支付方式:可不填, 1:现付，2到付，3回付，4周结，5月结，6货款扣，7季度结
+        Integer receiptCount; //回单数量
+        Double freightCollect; //代收运费：可不填
+        Double paymentCollect; //代收货款：可不填
+        String warehouseCode;//第三方参数:仓库编码
+        String ownerCode; //第三方参数:货主编码
+        String scheduleOrderCode; //第三方参数:调度单号
+        String orderType; //第三方参数:业务类型
+        String deliveryArea; //第三方参数:配送区域
+        String omsNumber; //第三方参数:oms订单号
+        Integer preDeliveryTime; //第三方参数:预约送货时间
+        String payMode; //第三方参数:付款方式
+        String note; //备注：可不填
+        Map<String, Object> extraFields; //备注扩展字端：可不填,key的值对应note1-6
+        String organizationPath; // 所属组织路径, 可不填
+        Double lng; //发货人经度
+        Double lat; //发货人纬度
+        //货物列表
+        List<CargoRequest> cargoList{
+                String cargoNumber;//货物编号:用于货物相关接口，需要增/删/改货物的话需要传此字段
+                String weight;//重量
+                String volume;//体积
+                String quantity;//件数
+                String value;//货值
+                String status;//货物状态
+                String name;//货物名称
+                String productModel;// 货物备注
+                String note1; // 自定义备注1
+                String note2; // 自定义备注2
+                String note3; // 自定义备注3
+                String note4; // 自定义备注4
+                String note5; // 自定义备注5
+                String note6; // 自定义备注6
+        }
+}
+```
+
 ## 错误码说明
 
 | 错误码 |  说明 |