Browse Source

更新接口文档

gmw 6 years ago
parent
commit
5396a7c11e
1 changed files with 110 additions and 110 deletions
  1. 110 110
      README.md

+ 110 - 110
README.md

@@ -1633,70 +1633,70 @@
 OrderEntity结构如下:
 ```java
 {
-        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): 集货位:可不填 ,
+        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 ,
+            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): 重量
+        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) //重量
         }
 }
 ```
@@ -1706,61 +1706,61 @@ OrderEntity结构如下:
 CustomerOrderEntity结构如下:
 ```java
 {
-        appointArriveTime (integer): 预约送达时间:非必填 ,
-        consigneeAddress (string): 收货人地址:非必填 ,
-        consigneeName (string): 收货人姓名:非必填 ,
-        consigneePhone (string): 收货人电话:非必填 ,
-        consignerAddress (string): 发货人地址:必填 ,
-        consignerName (string): 发货人姓名:必填 ,
-        consignerPhone (string): 发货人电话:必填 ,
-        deliveryTime (integer): 提货时间:非必填 ,
-        deliveryType (integer): 提送类型:非必填 ,
-        deviceNumber (string): 绑定设备号:非必填 ,
-        endAddress (string): 目的地:非必填 ,
+        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)  纬度
+            lng (double), //经度
+            lat (double)  //纬度
         },
         //收货方经纬度
         consigneeLocation {
-            lng (double), 经度
-            lat (double)  纬度
+            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): 起始地:非必填
+        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): 重量
+            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) //重量
         }
 }
 ```