更新接口文档

README.md

@@ -31,9 +31,9 @@
 - [批量查询受理单接口](#批量查询受理单接口)
 - [撤销受理单接口](#撤销受理单接口)
 - [批量解绑受理单设备](#批量解绑受理单设备)
+- [请求参数说明](#请求参数说明)
 - [错误码说明](#错误码说明)
-- [字段说明](#字段说明)
-- [测试代码](#测试代码)
+
 
 ## 接口简介
 
@@ -1177,70 +1177,7 @@ CustomerEntity {
 
 | 参数名 | 必选 | 类型 | 说明 |
 |:----:|:---:|:-----:|:-----:|
-| `orders` | 是 | `Array[CustomerOrderEntity]` | 运单列表 |
-
-```
-其中CustomerOrderEntity结构如下:
-CustomerOrderEntity {
-    appointArriveTime (integer): 预约送达时间:非必填 ,
-    consigneeAddress (string): 收货人地址:非必填 ,
-    consigneeName (string): 收货人姓名:非必填 ,
-    consigneePhone (string): 收货人电话:非必填 ,
-    consignerAddress (string): 发货人地址:必填 ,
-    consignerName (string): 发货人姓名:必填 ,
-    consignerPhone (string): 发货人电话:必填 ,
-    deliveryTime (integer): 提货时间:非必填 ,
-    deliveryType (integer): 提送类型:非必填 ,
-    deviceNumber (string): 绑定设备号:非必填 ,
-    endAddress (string): 目的地:非必填 ,
-    //发货方经纬度
-    consignerLocation {
-        lng (double), 经度
-        lat (double)  纬度
-    },
-    //收货方经纬度
-    consigneeLocation {
-        lng (double), 经度
-        lat (double)  纬度
-    },
-    note1 (string): 自定义备注1:非必填 ,
-    note10 (string): 自定义备注10:非必填 ,
-    note11 (string): 自定义备注11:非必填 ,
-    note12 (string): 自定义备注12:非必填 ,
-    note2 (string): 自定义备注2:非必填 ,
-    note3 (string): 自定义备注3:非必填 ,
-    note4 (string): 自定义备注4:非必填 ,
-    note5 (string): 自定义备注5:非必填 ,
-    note6 (string): 自定义备注6:非必填 ,
-    note7 (string): 自定义备注7:非必填 ,
-    note8 (string): 自定义备注8:非必填 ,
-    note9 (string): 自定义备注8:非必填 ,
-    organizationPath (string): 组织机构:非必填 ,
-    originalOrderNumber (string): 原始单号:非必填 ,
-    receiptCount (integer): 回单数:非必填 ,
-    remarks (string): 备注:非必填 ,
-    shipperPay (number): 上游运费:非必填 ,
-    shipperPayType (integer): 上游运费支付方式:非必填 ,
-    startAddress (string): 起始地:非必填
-    cargoList {
-        cargoNumber (string): 货物编号:用于货物相关接口，需要增/删/改货物的话需要传此字段,
-        name (string): 货物名称 ,
-        note1 (string): 自定义备注1 ,
-        note2 (string): 自定义备注2 ,
-        note3 (string): 自定义备注3 ,
-        note4 (string): 自定义备注4 ,
-        note5 (string): 自定义备注5 ,
-        note6 (string): 自定义备注6 ,
-        productModel (string): 货物备注 ,
-        quantity (string): 件数 ,
-        status (string): 货物状态 ,
-        value (string): 货值 ,
-        volume (string): 体积 ,
-        weight (string): 重量
-    }
-
-}
-```
+| `orders` | 是 | Array[[CustomerOrderEntity](#受理单参数说明)] | 运单列表 |
 
 **返回示例**
 
@@ -1277,7 +1214,7 @@ CustomerOrderEntity {
 | 参数名 | 必选 | 类型 | 说明 |
 |:----:|:---:|:-----:|:-----:|
 | `number` | 是 | `string` | 受理单号 |
-| `order` | 是 | `CustomerOrderEntity` | 受理单 |
+| `order` | 是 | [CustomerOrderEntity](#受理单参数说明) | 受理单 |
 
 **返回示例**
 
@@ -1569,68 +1506,140 @@ 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
+OrderEntity结构如下:
+{
+        consignerAddress (string): 发货人地址:必填 ,
+        consignerName (string): 发货人姓名:必填 ,
+        consignerPhone (string): 发货人电话:必填 ,
+        batchNumber (string): 批次号：创建订单可不填，确认批次必填 ,
+        appointArriveTime (integer): 预约送到时间：时间戳格式，选填 ,
+        consigneeAddress (string): 收货人地址:可不填 ,
+        consigneeCity (string): 收货人所在城市:可不填 ,
+        consigneeDistrict (string): 收货人所在地区:可不填 ,
+        consigneeName (string): 收货人姓名:可不填 ,
+        consigneePhone (string): 收货人电话:可不填 ,
+        consigneeProvince (string): 收货人所在省份:可不填 ,
+        consignerCity (string): 发货人所在城市 ,
+        consignerDistrict (string): 发货人所在地区:可不填 ,
+        consignerProvince (string): 发货人所在省份：可不填 ,
+        customerOrderNumber (string): 客户单号:选填 ,
+        deliveryArea (string): 第三方参数:配送区域 ,
+        deliveryTime (integer): 提货时间:时间戳格式 ,
+        deliveryType (integer): 提送类型：选填, 1自提，2送货 ,
+        driverPay (number): 司机运费:可不填 ,
+        driverPayType (integer): 司机运费支付方式:可不填, 1:现付，2到付，3回付，4周结，5月结，6货款扣，7季度结 ,
+        endAddress (string): 目的地:选填 ,
+        freightCollect (number): 代收运费：可不填 ,
+        lat (number): 发货人纬度 ,
+        lng (number): 发货人经度 ,
+        note (string): 备注：可不填 ,
+        omsNumber (string): 第三方参数:OMS单号 ,
+        orderNumber (string): 订单号:客户系统和TMS系统中订单关联的唯一依据 ,
+        orderType (string): 第三方参数:业务类型 ,
+        organizationPath (string): 组织机构：可不填 ,
+        ownerCode (string): 第三方参数:货主编码 ,
+        payMode (string): 第三方参数:付款方式 ,
+        paymentCollect (number): 代收货款：可不填 ,
+        preDeliveryTime (integer): 第三方参数:预约送货时间 ,
+        receiptCount (integer): 回单数量 ,
+        scheduleOrderCode (string): 第三方参数:调度单号 ,
+        shipperPay (number): 上游运费:可不填 ,
+        shipperPayType (integer): 上游运费支付方式:可不填, 1:现付，2到付，3回付，4周结，5月结，6货款扣，7季度结 ,
+        startAddress (string): 起始地:选填 ,
+        warehouseCode (string): 第三方参数:仓库编码 ,
+        wmsLocation (string): 集货位：可不填 ,
+        extraFields { 扩展字端：可不填,根据需要使用 ,
+            note1 (string): 自定义备注1 ,
+            note2 (string): 自定义备注2 ,
+            note3 (string): 自定义备注3 ,
+            note4 (string): 自定义备注4 ,
+            note5 (string): 自定义备注5 ,
+            note6 (string): 自定义备注6 ,
+        }
+        cargoList { (Array[货物请求]): 货物列表
+            cargoNumber (string): 货物编号:用于货物相关接口，需要增/删/改货物的话需要传次字段 ,
+            name (string): 货物名称 ,
+            note1 (string): 自定义备注1 ,
+            note2 (string): 自定义备注2 ,
+            note3 (string): 自定义备注3 ,
+            note4 (string): 自定义备注4 ,
+            note5 (string): 自定义备注5 ,
+            note6 (string): 自定义备注6 ,
+            orderNumber (string): 订单号 ,
+            productModel (string): 货物备注 ,
+            quantity (string): 件数 ,
+            status (string): 货物状态 ,
+            value (string): 货值 ,
+            volume (string): 体积 ,
+            weight (string): 重量
+        }
+}
+```
+
+#### 受理单参数说明
+```
+CustomerOrderEntity结构如下:
+{
+        appointArriveTime (integer): 预约送达时间:非必填 ,
+        consigneeAddress (string): 收货人地址:非必填 ,
+        consigneeName (string): 收货人姓名:非必填 ,
+        consigneePhone (string): 收货人电话:非必填 ,
+        consignerAddress (string): 发货人地址:必填 ,
+        consignerName (string): 发货人姓名:必填 ,
+        consignerPhone (string): 发货人电话:必填 ,
+        deliveryTime (integer): 提货时间:非必填 ,
+        deliveryType (integer): 提送类型:非必填 ,
+        deviceNumber (string): 绑定设备号:非必填 ,
+        endAddress (string): 目的地:非必填 ,
+        //发货方经纬度
+        consignerLocation {
+            lng (double), 经度
+            lat (double)  纬度
+        },
+        //收货方经纬度
+        consigneeLocation {
+            lng (double), 经度
+            lat (double)  纬度
+        },
+        note1 (string): 自定义备注1:非必填 ,
+        note2 (string): 自定义备注2:非必填 ,
+        note3 (string): 自定义备注3:非必填 ,
+        note4 (string): 自定义备注4:非必填 ,
+        note5 (string): 自定义备注5:非必填 ,
+        note6 (string): 自定义备注6:非必填 ,
+        note7 (string): 自定义备注7:非必填 ,
+        note8 (string): 自定义备注8:非必填 ,
+        note9 (string): 自定义备注8:非必填 ,
+        note10 (string): 自定义备注10:非必填 ,
+        note11 (string): 自定义备注11:非必填 ,
+        note12 (string): 自定义备注12:非必填 ,
+        organizationPath (string): 组织机构:非必填 ,
+        originalOrderNumber (string): 原始单号:非必填 ,
+        receiptCount (integer): 回单数:非必填 ,
+        remarks (string): 备注:非必填 ,
+        shipperPay (number): 上游运费:非必填 ,
+        shipperPayType (integer): 上游运费支付方式:非必填 ,
+        startAddress (string): 起始地:非必填
+        cargoList {
+            cargoNumber (string): 货物编号:用于货物相关接口，需要增/删/改货物的话需要传此字段,
+            name (string): 货物名称 ,
+            note1 (string): 自定义备注1 ,
+            note2 (string): 自定义备注2 ,
+            note3 (string): 自定义备注3 ,
+            note4 (string): 自定义备注4 ,
+            note5 (string): 自定义备注5 ,
+            note6 (string): 自定义备注6 ,
+            productModel (string): 货物备注 ,
+            quantity (string): 件数 ,
+            status (string): 货物状态 ,
+            value (string): 货值 ,
+            volume (string): 体积 ,
+            weight (string): 重量
         }
 }
 ```
@@ -1656,13 +1665,3 @@ OrderEntity {
 |10022| 批次号必填|
 |10023| 订单创建失败|
 |10024| 传入订单列表不能为空|
-
-## 测试代码
-```
-接口测试例子
-TestMain.java
-
-oauth授权例子
-1：mvn clean jetty:run
-2：用浏览器访问：http://localhost:9090
-```