Browse Source

调整参数说明

gmw 5 years ago
parent
commit
5d1f936583
1 changed files with 47 additions and 45 deletions
  1. 47 45
      README.md

+ 47 - 45
README.md

@@ -1870,30 +1870,25 @@ OrderEntity结构如下:
 ModifyOrderEntity结构如下:
 ```java
 {
-    //预约送达时间,精确到秒的时间戳
-    "appointArriveTime": 1561627095,
-    "customerOrderNumber": "客户单号",
-    //提货时间,精确到秒的时间戳
-    "deliveryTime": 1561627095,
-    //提送类型, 1自提,2送货
-    "deliveryType": 1,
-    "startAddress": "起始地",
-    "endAddress": "目的地",
-    "note": "备注",
-    //此字段请参考TMS三方接口文档常见问题的组织机构相关问题
-    "organizationPath": "组织机构path",
-    //回单数量
-    "receiptCount": 2,
+    "appointArriveTime": 1561627095, //预约送达时间,精确到秒的时间戳
+    "customerOrderNumber": "", //客户单号
+    "deliveryTime": 1561627095, //提货时间,精确到秒的时间戳
+    "deliveryType": 1, //提送类型, 1自提,2送货
+    "startAddress": "", //起始地
+    "endAddress": "", //目的地
+    "note": "", //备注
+    "organizationPath": "", //组织机构path,此字段请参考TMS三方接口文档常见问题的组织机构相关问题
+    "receiptCount": 2, //回单数量
     //发货人信息
     "consigner": {
-        "name": "姓名",
-        "phone": "手机号",
+        "name": "", //姓名
+        "phone": "", //手机号
         "address": {
-            "province": "",
-            "city": "",
-            "district": "",
-            "address": "详细地址",
-            "streetNumber": "街道名称",
+            "province": "", //省
+            "city": "", //市
+            "district": "", //区
+            "address": "", //详细地址
+            "streetNumber": "", //街道名称
             "lat": 0.0, //纬度
             "lng": 0.0 //精度
         }
@@ -1901,42 +1896,49 @@ ModifyOrderEntity结构如下:
     //收货方信息,consignees=null或不传递此字段则不修改,否则会覆盖原本的收货方信息
     "consignees": [
         {
-            "name": "姓名",
-            "phone": "手机号",
+            "name": "", //姓名
+            "phone": "", //手机号
             "address": {
-                "province": "",
-                "city": "",
-                "district": "",
-                "address": "详细地址",
-                "streetNumber": "街道名称",
+                "province": "", //省
+                "city": "", //市
+                "district": "", //区
+                "address": "", //详细地址
+                "streetNumber": "", //街道名称
                 "lat": 0.0, //纬度
                 "lng": 0.0 //精度
             }
         }
     ],
-    /*运单自定义备注,只需传递需要修改的备注即可,值为null或者未传递的不会修改
-      目前TMS系统共有12个自定义备注*/
+    /*运单自定义备注,只需传递需要修改的备注即可,值为null或者未传递的不会修改*/
     "customNotes": {
-        "note1": "自定义备注1",
-        "note2": "自定义备注2",
-        .....
-        "note12": "自定义备注12"
+        "note1": "", //自定义备注1
+        "note2": "", //自定义备注2
+        "note3": "", //自定义备注3
+        "note4": "", //自定义备注4
+        "note5": "", //自定义备注5
+        "note6": "", //自定义备注6
+        "note7": "", //自定义备注7
+        "note8": "", //自定义备注8
+        "note9": "", //自定义备注8
+        "note10": "", //自定义备注10
+        "note11": "", //自定义备注11
+        "note12": "" //自定义备注12
     },
     //货物信息列表,orderCargoes=null或不传递此字段则不修改,否则会覆盖原本的货物信息
     "orderCargoes": [
         {
-            "name": "货物名称",
+            "name": "", //货物名称
             "quantity": 1.0, //件数
-            "value": 2.0,    //货值
-            "volume": 3.0,   //体积
-            "weight": 4.0,   //重量
-            "productModel": "备注",
-            "note1": "自定义货物备注1",
-            "note2": "自定义货物备注2",
-            "note3": "自定义货物备注3",
-            "note4": "自定义货物备注4",
-            "note5": "自定义货物备注5",
-            "note6": "自定义货物备注6"
+            "value": 2.0, //货值
+            "volume": 3.0, //体积
+            "weight": 4.0, //重量
+            "productModel": "", //备注
+            "note1": "", //自定义货物备注1
+            "note2": "", //自定义货物备注2
+            "note3": "", //自定义货物备注3
+            "note4": "", //自定义货物备注4
+            "note5": "", //自定义货物备注5
+            "note6": "" //自定义货物备注6
         }
     ]
 }