gmw 4 years ago
parent
commit
38527f6609
1 changed files with 17 additions and 12 deletions
  1. 17 12
      README.md

+ 17 - 12
README.md

@@ -320,11 +320,12 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 
 
 |名称|说明|类型|
 |名称|说明|类型|
 |---|---|---|
 |---|---|---|
+|**page**  <br>*必填*|当前页  <br>**最小值** : `1`  <br>**最大值** : `1000`|string|
+|**size**  <br>*必填*|单页数量  <br>**最小值** : `1`  <br>**最大值** : `50`|string|
 |**orderNumbers**  <br>*可选*|运单号列表,一次最多50单  <br>**长度** : `1 - 50`|< string > array|
 |**orderNumbers**  <br>*可选*|运单号列表,一次最多50单  <br>**长度** : `1 - 50`|< string > array|
-|**timeType**  <br>*可选*|时间类型  <br>**取值** : `created(创建时间),opened(开单时间),signed(签收时间)`|string|
+|**timeType**  <br>*可选*|时间类型  <br>**取值** : `created(创建时间),opened(开单时间),signed(完成时间),arrivedTime(到达时间),appointArriveTime(预约送达时间)`|string|
 |**beginDate**  <br>*可选*|开始时间 <br>**格式** : `yyyy-MM-dd HH:mm:ss`|string|
 |**beginDate**  <br>*可选*|开始时间 <br>**格式** : `yyyy-MM-dd HH:mm:ss`|string|
 |**endDate**  <br>*可选*|结束时间 <br>**格式** : `yyyy-MM-dd HH:mm:ss`|string|
 |**endDate**  <br>*可选*|结束时间 <br>**格式** : `yyyy-MM-dd HH:mm:ss`|string|
-|**number**  <br>*可选*|运单号,支持模糊搜索|string|
 |**originalOrderNumber**  <br>*可选*|客户单号,支持模糊搜索|string|
 |**originalOrderNumber**  <br>*可选*|客户单号,支持模糊搜索|string|
 |**startAddress**  <br>*可选*|起始地 <br>**长度** : `0 - 20`|string|
 |**startAddress**  <br>*可选*|起始地 <br>**长度** : `0 - 20`|string|
 |**endAddress**  <br>*可选*|目的地 <br>**长度** : `0 - 20`|string|
 |**endAddress**  <br>*可选*|目的地 <br>**长度** : `0 - 20`|string|
@@ -333,8 +334,6 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 |**consigneeName**  <br>*可选*|收货方姓名 <br>**长度** : `0 - 45`|string|
 |**consigneeName**  <br>*可选*|收货方姓名 <br>**长度** : `0 - 45`|string|
 |**consigneePhone**  <br>*可选*|收货方电话 <br>**长度** : `0 - 20`|string|
 |**consigneePhone**  <br>*可选*|收货方电话 <br>**长度** : `0 - 20`|string|
 |**remarks**  <br>*可选*|备注 <br>**长度** : `0 - 256`|string|
 |**remarks**  <br>*可选*|备注 <br>**长度** : `0 - 256`|string|
-|**page**  <br>*必填*|当前页  <br>**最小值** : `1`  <br>**最大值** : `1000`|string|
-|**size**  <br>*必填*|单页数量  <br>**最小值** : `1`  <br>**最大值** : `50`|string|
 
 
 **返回示例**
 **返回示例**
 
 
@@ -343,8 +342,14 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 ```java
 ```java
 {
 {
     "code": 200,
     "code": 200,
-    "data": true,
-    "message": null
+    "message": null,
+    "data": {
+        "page": 1, //当前页
+        "size": 10, //当页数量
+        "total": 3, //返回数据总数
+        "totalPagesCount": 1, //总页数
+        "elements": [....] //运单数据
+    }
 }
 }
 ```
 ```
 
 
@@ -926,7 +931,7 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 |名称|说明|类型|
 |名称|说明|类型|
 |---|---|---|
 |---|---|---|
 |**name**  <br>*必填*|货物名称  <br>**长度** : `1 - 150`|string|
 |**name**  <br>*必填*|货物名称  <br>**长度** : `1 - 150`|string|
-|**type**  <br>*必填*|货物类型名称|可选值请参考[《部网络货运信息交互系统代码集》](/resources/pdf/部网络货运信息交互系统代码集.pdf)|
+|**type**  <br>*必填*|货物类型名称|可选值请参考[《部网络货运信息交互系统代码集》](https://fanyun-wlhy.oss-cn-hangzhou.aliyuncs.com/resources/部网络货运信息交互系统代码集.pdf)|
 |**weight**  <br>*必填*|重量(千克或吨,由系统设置的重量单位决定)  <br>**最小值** : `0`  <br>**最大值** : `99999999`|number (double)|
 |**weight**  <br>*必填*|重量(千克或吨,由系统设置的重量单位决定)  <br>**最小值** : `0`  <br>**最大值** : `99999999`|number (double)|
 |**quantity**  <br>*可选*|件数  <br>**最小值** : `0`  <br>**最大值** : `999999`|number (double)|
 |**quantity**  <br>*可选*|件数  <br>**最小值** : `0`  <br>**最大值** : `999999`|number (double)|
 |**value**  <br>*可选*|货值  <br>**最小值** : `0`  <br>**最大值** : `9999999`|number (double)|
 |**value**  <br>*可选*|货值  <br>**最小值** : `0`  <br>**最大值** : `9999999`|number (double)|
@@ -956,7 +961,7 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 |---|---|---|
 |---|---|---|
 |**name**  <br>*必填*|银行开户名  <br>**长度** : `1 - 20`|string|
 |**name**  <br>*必填*|银行开户名  <br>**长度** : `1 - 20`|string|
 |**bankCardNumber**  <br>*必填*|银行卡号 |number (double)|
 |**bankCardNumber**  <br>*必填*|银行卡号 |number (double)|
-|**bankName**  <br>*必填*|开户银行,支持的银行请参考[《部网络货运信息交互系统代码集》](/resources/pdf/部网络货运信息交互系统代码集.pdf)|string|
+|**bankName**  <br>*必填*|开户银行,支持的银行请参考[《部网络货运信息交互系统代码集》](https://fanyun-wlhy.oss-cn-hangzhou.aliyuncs.com/resources/部网络货运信息交互系统代码集.pdf)|string|
 |**idCard**  <br>*必填*|身份证  <br>**长度** : `18`|string|
 |**idCard**  <br>*必填*|身份证  <br>**长度** : `18`|string|
 |**phoneNumber**  <br>*可选*|手机号  <br>**长度** : `11`|string|
 |**phoneNumber**  <br>*可选*|手机号  <br>**长度** : `11`|string|
 
 
@@ -1011,11 +1016,11 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 |**issuingAuthority**  <br>*必填*|发证机关  <br>**长度** : `1 - 50`|string|
 |**issuingAuthority**  <br>*必填*|发证机关  <br>**长度** : `1 - 50`|string|
 |**merchantName**  <br>*必填*|业户名称|string|
 |**merchantName**  <br>*必填*|业户名称|string|
 |**natureOfUse**  <br>*必填*|使用性质  <br>**长度** : `1 - 20`|string|
 |**natureOfUse**  <br>*必填*|使用性质  <br>**长度** : `1 - 20`|string|
-|**licensePlateColor**  <br>*与`licensePlateColorCode`二选一必填*|车牌颜色,和车牌颜色代码对应,两个中必填一个,优先使用本字段的值,代码集请参考[《部网络货运信息交互系统代码集》](/resources/pdf/部网络货运信息交互系统代码集.pdf)|string|
+|**licensePlateColor**  <br>*与`licensePlateColorCode`二选一必填*|车牌颜色,和车牌颜色代码对应,两个中必填一个,优先使用本字段的值,代码集请参考[《部网络货运信息交互系统代码集》](https://fanyun-wlhy.oss-cn-hangzhou.aliyuncs.com/resources/部网络货运信息交互系统代码集.pdf)|string|
 |**licensePlateColorCode**  <br>*与`licensePlateColor`二选一必填*|车牌颜色代码,和车牌颜色对应|string|
 |**licensePlateColorCode**  <br>*与`licensePlateColor`二选一必填*|车牌颜色代码,和车牌颜色对应|string|
-|**vehicleType**  <br>*与`vehicleTypeCode`二选一必填*|车辆类型,和车辆类型代码对应,两个中必填一个,优先使用本字段的值,代码集请参考[《部网络货运信息交互系统代码集》](/resources/pdf/部网络货运信息交互系统代码集.pdf)|string|
+|**vehicleType**  <br>*与`vehicleTypeCode`二选一必填*|车辆类型,和车辆类型代码对应,两个中必填一个,优先使用本字段的值,代码集请参考[《部网络货运信息交互系统代码集》](https://fanyun-wlhy.oss-cn-hangzhou.aliyuncs.com/resources/部网络货运信息交互系统代码集.pdf)|string|
 |**vehicleTypeCode**  <br>*与`vehicleType`二选一必填*|车辆类型代码,和车辆类型对应|string|
 |**vehicleTypeCode**  <br>*与`vehicleType`二选一必填*|车辆类型代码,和车辆类型对应|string|
-|**vehicleEnergyType**  <br>*与`vehicleEnergyTypeCode`二选一必填*|车辆能源类型,和车辆能源类型代码对应,两个中必填一个,优先使用本字段的值,代码集请参考[《部网络货运信息交互系统代码集》](/resources/pdf/部网络货运信息交互系统代码集.pdf)|string|
+|**vehicleEnergyType**  <br>*与`vehicleEnergyTypeCode`二选一必填*|车辆能源类型,和车辆能源类型代码对应,两个中必填一个,优先使用本字段的值,代码集请参考[《部网络货运信息交互系统代码集》](https://fanyun-wlhy.oss-cn-hangzhou.aliyuncs.com/resources/部网络货运信息交互系统代码集.pdf)|string|
 |**vehicleEnergyTypeCode**  <br>*与`vehicleEnergyType`二选一必填*|车辆能源类型代码,和车辆能源类型对应|string|
 |**vehicleEnergyTypeCode**  <br>*与`vehicleEnergyType`二选一必填*|车辆能源类型代码,和车辆能源类型对应|string|
 |**issueDate**  <br>*必填*|发证日期,时间戳,精确到秒|integer (int64)|
 |**issueDate**  <br>*必填*|发证日期,时间戳,精确到秒|integer (int64)|
 |**registrationDate**  <br>*必填*|注册日期,时间戳,精确到秒|integer (int64)|
 |**registrationDate**  <br>*必填*|注册日期,时间戳,精确到秒|integer (int64)|
@@ -1041,7 +1046,7 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 |---|---|---|
 |---|---|---|
 |**bankCardNumber**  <br>*必填*|银行卡号,该字段为收款人的唯一标识|string|
 |**bankCardNumber**  <br>*必填*|银行卡号,该字段为收款人的唯一标识|string|
 |**name**  <br>*必填*|银行开户名  <br>**长度** : `1 - 20`|string|
 |**name**  <br>*必填*|银行开户名  <br>**长度** : `1 - 20`|string|
-|**bankName**  <br>*必填*|开户银行,支持的银行请参考[《部网络货运信息交互系统代码集》](/resources/pdf/部网络货运信息交互系统代码集.pdf)|string|
+|**bankName**  <br>*必填*|开户银行,支持的银行请参考[《部网络货运信息交互系统代码集》](https://fanyun-wlhy.oss-cn-hangzhou.aliyuncs.com/resources/部网络货运信息交互系统代码集.pdf)|string|
 |**idCard**  <br>*必填*|身份证|string|
 |**idCard**  <br>*必填*|身份证|string|
 |**organizationName**  <br>*可选*|组织机构名称,会创建至对应组织机构下,默认创建到总部|string|
 |**organizationName**  <br>*可选*|组织机构名称,会创建至对应组织机构下,默认创建到总部|string|
 |**phoneNumber**  <br>*可选*|手机号  <br>**长度** : `11`|string|
 |**phoneNumber**  <br>*可选*|手机号  <br>**长度** : `11`|string|