Browse Source

更新接口文档

gmw 6 years ago
parent
commit
17854b92dd
1 changed files with 24 additions and 22 deletions
  1. 24 22
      README.md

+ 24 - 22
README.md

@@ -332,8 +332,8 @@
         "total": 100,
         "elements": [
             {
-                "id": "5c4ad2619c023a001044079a", //订单id
-                "uid": "5bc725b6e4b07d20a861600f", //主账号uid
+                "id": "5c4ad2619c023a001044079a", # 订单id
+                "uid": "5bc725b6e4b07d20a861600f", 主账号uid
                 "number": "1901251709800228", //运单号
                 "wmsNumber": null, //wmsNumber,即创建订单时的orderNumber
                 "wmsLocation": null, //集货位
@@ -1116,8 +1116,8 @@ public class AloginventoryRequest {
     "carNumber": "浙A12345", /*车牌号码*/
     "groupName": "xx运输队", /*车队*/
     "driverPhone": "13812345678", /*司机电话*/
-    "orderNumbers":["2323424234234","609171412804505"] /*tms车次订单集合*/
-    "wmsNumbers" : "wmsNumber",/*出库单号集合*/
+    "orderNumbers":["2323424234234","609171412804505"], /*tms车次订单集合*/
+    "wmsNumbers": "wmsNumber",/*出库单号集合*/
     "customerOrderNumbers": "xxx", /*客户单号集合*/
     "remark":"232323", /*备注*/
 }
@@ -1213,11 +1213,11 @@ public class AloginventoryRequest {
 ```
 
 **对象说明:**
-```json
-public class OrganizationEntity implements Serializable {
-    private Integer nodeId; // 机构节点id
-    private String name; // 机构名
-    private String path; // 父节点路径
+```
+{
+    Integer nodeId; // 机构节点id
+    String name; // 机构名
+    String path; // 父节点路径
 }
 ```
 
@@ -1237,24 +1237,24 @@ public class OrganizationEntity implements Serializable {
 |:----:|:---:|:-----:|:-----:|
 | `customers` | 是 | `Array[CustomerEntity]` | 客户列表 |
 
-```json
+```
 其中CustomerEntity结构如下:
-CustomerEntity {
-        private String name; //客户名称:必填
+{
+        String name; //客户名称:必填
     
-        private String phone; //客户电话:必填
+        String phone; //客户电话:必填
     
-        private String address; //客户地址:必填
+        String address; //客户地址:必填
     
-        private int type; //客户类型:必填 1发货人,2收货人
+        int type; //客户类型:必填 1发货人,2收货人
     
-        private int paymentType; //支付方式:必填 1现付 2到付 3回付 4周结 5月结 6货款扣 7季度结
+        int paymentType; //支付方式:必填 1现付 2到付 3回付 4周结 5月结 6货款扣 7季度结
     
-        private String remark1; //备注1:非必填
+        String remark1; //备注1:非必填
     
-        private String remark2; //备注2:非必填
+        String remark2; //备注2:非必填
     
-        private String remark3; //备注3:非必填
+        String remark3; //备注3:非必填
 }
 ```
 
@@ -1610,14 +1610,16 @@ CustomerEntity {
 ```
 - 调用失败示例
 
-```json
 1.受理单号列表中存在未绑定设备的受理单:
+```json
 {
     "message": "受理单S1811011025811886未绑定设备!",
     "status": 500
 }
+```
 
 2.受理单查询不到,请确认受理单是否存在,或者是否使用主账号调用的接口:
+```json
 {
     "message": "受理单不存在!",
     "status": 500
@@ -1628,7 +1630,7 @@ CustomerEntity {
 ## 部分参数说明
 
 #### 运单参数说明
-```json
+```
 OrderEntity结构如下:
 {
         consignerAddress (string): 发货人地址:必填 ,
@@ -1701,7 +1703,7 @@ OrderEntity结构如下:
 
 
 #### 受理单参数说明
-```json
+```
 CustomerOrderEntity结构如下:
 {
         appointArriveTime (integer): 预约送达时间:非必填 ,