Pārlūkot izejas kodu

调整参数说明

gmw 5 gadi atpakaļ
vecāks
revīzija
c6a16726a1
1 mainītis faili ar 146 papildinājumiem un 155 dzēšanām
  1. 146 155
      README.md

+ 146 - 155
README.md

@@ -74,7 +74,7 @@
 1. 404表示接口不存在,请检查调用的接口地址,协议的格式是否正确
 2. 401表示授权失败,需要重新登陆获取access_token
 3. 200,201,20*表示调用接口成功,返回body中调用结果,是http JSON格式的,包含以下字段
-4. 接口中所有时间均使用时间戳,单位为
+4. 接口中所有时间均使用时间戳,精确到
 
 - **code**:状态码,取值有 200,非200;200 表示接口调用成功, 非200 表示接口调用失败
 - **message**:错误信息,当接口调用失败(状态码为 非200)时,返回的错误信息
@@ -1705,23 +1705,23 @@
 
 ```java
 {
-    "code":200,
-    "message":null,
-    "data":[
+    "code": 200,
+    "message": null,
+    "data": [
         {
-            "nodeId":0,
-            "name":"总部",
-            "path":"0-0"
+            "nodeId": 0, //机构节点id
+            "name": "总部", //机构名
+            "path": "0-0" //节点路径,如无特殊说明,其他接口中的组织机构字段均使用此字段值
         },
         {
-            "nodeId":11,
-            "name":"网点1",
-            "path":"0-11"
+            "nodeId": 11,
+            "name": "网点1",
+            "path": "0-11"
         },
         {
-            "nodeId":12,
-            "name":"杭州网点2",
-            "path":"0-12"
+            "nodeId": 12,
+            "name": "杭州网点2",
+            "path": "0-12"
         }
     ]
 }
@@ -1735,14 +1735,6 @@
 }
 ```
 
-**对象说明:**
-```java
-{
-    Integer nodeId; // 机构节点id
-    String name; // 机构名
-    String path; // 父节点路径
-}
-```
 
 ## 添加客户接口
 
@@ -1763,21 +1755,14 @@
 其中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:非必填
+    "name": "", //客户名称:必填
+    "phone": "", //客户电话:必填
+    "address": "", //客户地址:必填
+    "type": 1, //客户类型:必填 1)发货人,2)收货人
+    "paymentType": 1, //支付方式:必填, 1)现付, 2)到付, 3)回付, 4)周结, 5)月结, 6)货款扣, 7)季度结, 8)在线支付, 9)到付月结
+    "remark1": "", //备注1:非必填
+    "remark2": "", //备注2:非必填
+    "remark3": "" //备注3:非必填
 }
 ```
 
@@ -1808,73 +1793,76 @@
 OrderEntity结构如下:
 ```java
 {
-        orderNumber (string) //用于唯一性检测,此字段不在系统中展示:必填 ,
-        consignerAddress (string) //发货人地址:必填 ,
-        consignerName (string) //发货人姓名:必填 ,
-        consignerPhone (string) //发货人电话:必填 ,
-        deliveryTime (integer) //提货时间:时间戳格式:必填 ,
-        deliveryType (integer) //提送类型:选填, 1自提,2送货 ,
-        customerOrderNumber (string) //客户单号:选填 ,
-        appointArriveTime (integer) //预约送到时间:时间戳格式,选填 ,
-        consigneeAddress (string) //收货人地址:可不填 ,
-        consigneeCity (string) //收货人所在城市:可不填 ,
-        consigneeDistrict (string) //收货人所在地区:可不填 ,
-        consigneeName (string) //收货人姓名:可不填 ,
-        consigneePhone (string) //收货人电话:可不填 ,
-        consigneeProvince (string) //收货人所在省份:可不填 ,
-        consignerCity (string) //发货人所在城市 ,
-        consignerDistrict (string) //发货人所在地区:可不填 ,
-        consignerProvince (string) //发货人所在省份:可不填 ,
-        driverPay (number) //司机运费:可不填 ,
-        driverPayType (integer) //司机运费支付方式:可不填, 1:现付,2到付,3回付,4周结,5月结,6货款扣,7季度结 ,
-        endAddress (string) //目的地:选填 ,
-        freightCollect (number) //代收运费:可不填 ,
-        //发货方经纬度
-        consignerLocation {
-            lng (double), //经度
-            lat (double)  //纬度
-        },
-        //收货方经纬度
-        consigneeLocation {
-            lng (double), //经度
-            lat (double)  //纬度
-        },
-        note (string) //备注:可不填 ,
-        organizationPath (string) //组织机构:可不填 ,
-        paymentCollect (number) //代收货款:可不填 ,
-        receiptCount (integer) //回单数量 ,
-        shipperPay (number) //上游运费:可不填 ,
-        shipperPayType (integer) //上游运费支付方式:可不填, 1:现付,2到付,3回付,4周结,5月结,6货款扣,7季度结 ,
-        startAddress (string) //起始地:选填 ,
-        wmsLocation (string) //集货位:可不填 ,
-        extraFields { //扩展字端:可不填,根据需要使用 ,
-            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) //自定义备注9 ,
-            note10 (string) //自定义备注10 ,
-            note11 (string) //自定义备注11 ,
-            note12 (string) //自定义备注12 ,
-        }
-        cargoList {  //货物列表 (Array[货物请求])
-            name (string) //货物名称 ,
-            note1 (string) //自定义备注1 ,
-            note2 (string) //自定义备注2 ,
-            note3 (string) //自定义备注3 ,
-            note4 (string) //自定义备注4 ,
-            note5 (string) //自定义备注5 ,
-            note6 (string) //自定义备注6 ,
-            productModel (string) //货物备注 ,
-            quantity (string) //件数 ,
-            value (string) //货值 ,
-            volume (string) //体积 ,
-            weight (string) //重量
+    "orderNumber": "", //用于唯一性检测,此字段不在系统中展示:必填
+    "consignerAddress": "", //发货人地址:必填
+    "consignerName": "", //发货人姓名:必填
+    "consignerPhone": "", //发货人电话:必填
+    "deliveryTime": 1573180245, //提货时间:时间戳,精确到秒:必填
+    "deliveryType": 1, //提送类型:选填, 1)自提,2)送货
+    "customerOrderNumber": "", //客户单号:选填
+    "appointArriveTime": 1573180245, //预约送到时间:时间戳,精确到秒:选填
+    "consigneeAddress": "", //收货人地址:可不填
+    "consigneeCity": "", //收货人所在城市:可不填
+    "consigneeDistrict": "", //收货人所在地区:可不填
+    "consigneeName": "", //收货人姓名:可不填
+    "consigneePhone": "", //收货人电话:可不填
+    "consigneeProvince": "", //收货人所在省份:可不填
+    "consignerCity": "", //发货人所在城市
+    "consignerDistrict": "", //发货人所在地区:可不填
+    "consignerProvince": "", //发货人所在省份:可不填
+    "driverPay": 12.0, //司机运费:可不填
+    "driverPayType": 1, //司机运费支付方式:可不填, 1)现付, 2)到付, 3)回付, 4)周结, 5)月结, 6)货款扣, 7)季度结, 8)在线支付, 9)到付月结
+    "startAddress": "", //起始地:选填
+    "endAddress": "", //目的地:选填
+    "freightCollect": 12.0, //代收运费:可不填
+    //发货方经纬度
+    "consignerLocation": {
+        "lng": "", //经度
+        "lat": "" //纬度
+    },
+    //收货方经纬度
+    "consigneeLocation": {
+        "lng": "", //经度
+        "lat": "" //纬度
+    },
+    "note": "", //备注:可不填
+    "organizationPath": "0-11", //组织机构:可不填,具体请看常见问题中的组织机构相关内容
+    "paymentCollect": 12.0, //代收货款:可不填
+    "receiptCount": 1, //回单数量
+    "shipperPay": 12.0, //上游运费:可不填
+    "shipperPayType": 1, //上游运费支付方式:可不填, 1)现付, 2)到付, 3)回付, 4)周结, 5)月结, 6)货款扣, 7)季度结, 8)在线支付, 9)到付月结
+    "wmsLocation": "", //集货位:可不填
+    "extraFields": { //扩展字端:可不填,根据需要使用
+        "note1": "", //自定义备注1
+        "note2": "", //自定义备注2
+        "note3": "", //自定义备注3
+        "note4": "", //自定义备注4
+        "note5": "", //自定义备注5
+        "note6": "", //自定义备注6
+        "note7": "", //自定义备注7
+        "note8": "", //自定义备注8
+        "note9": "", //自定义备注9
+        "note10": "", //自定义备注10
+        "note11": "", //自定义备注11
+        "note12": "" //自定义备注12
+    },
+    //货物列表
+    "cargoList": [
+        {
+            "name": "", //货物名称
+            "note1": "", //自定义备注1
+            "note2": "", //自定义备注2
+            "note3": "", //自定义备注3
+            "note4": "", //自定义备注4
+            "note5": "", //自定义备注5
+            "note6": "", //自定义备注6
+            "productModel": "", //货物备注
+            "quantity": 1, //件数
+            "value": 2, //货值
+            "volume": 3, //体积
+            "weight": 4 //重量
         }
+    ]
 }
 ```
 
@@ -1958,59 +1946,62 @@ ModifyOrderEntity结构如下:
 CustomerOrderEntity结构如下:
 ```java
 {
-        consignerAddress (string) //发货人地址:必填 ,
-        consignerName (string) //发货人姓名:必填 ,
-        consignerPhone (string) //发货人电话:必填 ,
-        appointArriveTime (integer) //预约送达时间:非必填 ,
-        originalOrderNumber (string) //客户单号:非必填 ,
-        consigneeAddress (string) //收货人地址:非必填 ,
-        consigneeName (string) //收货人姓名:非必填 ,
-        consigneePhone (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) //组织机构:非必填 ,
-        receiptCount (integer) //回单数:非必填 ,
-        remarks (string) //备注:非必填 ,
-        shipperPay (number) //上游运费:非必填 ,
-        shipperPayType (integer) //上游运费支付方式:非必填 ,
-        startAddress (string) //起始地:非必填
-        cargoList {
-            name (string) //货物名称 ,
-            note1 (string) //自定义备注1 ,
-            note2 (string) //自定义备注2 ,
-            note3 (string) //自定义备注3 ,
-            note4 (string) //自定义备注4 ,
-            note5 (string) //自定义备注5 ,
-            note6 (string) //自定义备注6 ,
-            productModel (string) //货物备注 ,
-            quantity (string) //件数 ,
-            value (string) //货值 ,
-            volume (string) //体积 ,
-            weight (string) //重量
+    "consignerAddress": "", //发货人地址:必填
+    "consignerName": "", //发货人姓名:必填
+    "consignerPhone": "", //发货人电话:必填
+    "appointArriveTime": 1573178874, //预约送达时间:非必填,时间戳,精确到秒
+    "originalOrderNumber": "", //客户单号:非必填
+    "consigneeAddress": "", //收货人地址:非必填
+    "consigneeName": "", //收货人姓名:非必填
+    "consigneePhone": "", //收货人电话:非必填
+    "deliveryTime": 1573178874, //提货时间:非必填,时间戳,精确到秒
+    "deliveryType": 1, //提送类型:非必填,1)自提, 2)送货
+    "deviceNumber": "", //绑定设备号:非必填
+    "startAddress": "", //起始地:非必填
+    "endAddress": "", //目的地:非必填
+    //发货方经纬度:非必填
+    "consignerLocation": {
+        "lng": 0.0, //经度
+        "lat": 0.0 //纬度
+    },
+    //收货方经纬度:非必填
+    "consigneeLocation": {
+        "lng": 0.0, //经度
+        "lat": 0.0 //纬度
+    },
+    "note1": "", //自定义备注1:非必填
+    "note2": "", //自定义备注2:非必填
+    "note3": "", //自定义备注3:非必填
+    "note4": "", //自定义备注4:非必填
+    "note5": "", //自定义备注5:非必填
+    "note6": "", //自定义备注6:非必填
+    "note7": "", //自定义备注7:非必填
+    "note8": "", //自定义备注8:非必填
+    "note9": "", //自定义备注8:非必填
+    "note10": "", //自定义备注10:非必填
+    "note11": "", //自定义备注11:非必填
+    "note12": "", //自定义备注12:非必填
+    "organizationPath": "0-11", //组织机构:非必填,具体请看常见问题中的组织机构相关内容
+    "receiptCount": 1, //回单数:非必填
+    "remarks": "", //备注:非必填
+    "shipperPay": 12.0, //上游运费:非必填
+    "shipperPayType": 1, //上游运费支付方式:非必填,1)现付, 2)到付, 3)回付, 4)周结, 5)月结, 6)货款扣, 7)季度结, 8)在线支付, 9)到付月结
+    //货物列表
+    "cargoList": [
+        {
+            "name": "", //货物名称
+            "note1": "", //自定义备注1
+            "note2": "", //自定义备注2
+            "note3": "", //自定义备注3
+            "note4": "", //自定义备注4
+            "note5": "", //自定义备注5
+            "note6": "", //自定义备注6
+            "productModel": "", //货物备注
+            "quantity": 1, //件数
+            "value": 2, //货值
+            "volume": 3, //体积
+            "weight": 4 //重量
         }
+    ]
 }
 ```