Forráskód Böngészése

docs(README): 添加接口

gmw 4 éve
szülő
commit
389b8d956e
1 módosított fájl, 239 hozzáadás és 13 törlés
  1. 239 13
      README.md

+ 239 - 13
README.md

@@ -12,13 +12,21 @@
     - [更新登陆凭证接口](#%E6%9B%B4%E6%96%B0%E7%99%BB%E9%99%86%E5%87%AD%E8%AF%81%E6%8E%A5%E5%8F%A3)
 - [运单类接口](#%E8%BF%90%E5%8D%95%E7%B1%BB%E6%8E%A5%E5%8F%A3)
     - [创建运单接口](#%E5%88%9B%E5%BB%BA%E8%BF%90%E5%8D%95%E6%8E%A5%E5%8F%A3)
+- [基础信息类接口](#%E5%9F%BA%E7%A1%80%E4%BF%A1%E6%81%AF%E7%B1%BB%E6%8E%A5%E5%8F%A3)
+    - [批量创建司机接口](#%E6%89%B9%E9%87%8F%E5%88%9B%E5%BB%BA%E5%8F%B8%E6%9C%BA%E6%8E%A5%E5%8F%A3)
+    - [批量创建车辆接口](#%E6%89%B9%E9%87%8F%E5%88%9B%E5%BB%BA%E8%BD%A6%E8%BE%86%E6%8E%A5%E5%8F%A3)
+    - [批量创建收款人接口](#%E6%89%B9%E9%87%8F%E5%88%9B%E5%BB%BA%E6%94%B6%E6%AC%BE%E4%BA%BA%E6%8E%A5%E5%8F%A3)
 - [财务类接口](#%E8%B4%A2%E5%8A%A1%E7%B1%BB%E6%8E%A5%E5%8F%A3)
-    - [核销](#%E6%A0%B8%E9%94%80)
-- [参数说明](#%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E)
+    - [核销接口](#%E6%A0%B8%E9%94%80%E6%8E%A5%E5%8F%A3)
+    - [支付并核销接口](#%E6%94%AF%E4%BB%98%E5%B9%B6%E6%A0%B8%E9%94%80%E6%8E%A5%E5%8F%A3)
+- [接口参数说明](#%E6%8E%A5%E5%8F%A3%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E)
     - [运单](#%E8%BF%90%E5%8D%95)
     - [货物](#%E8%B4%A7%E7%89%A9)
     - [承运人](#%E6%89%BF%E8%BF%90%E4%BA%BA)
     - [地址](#%E5%9C%B0%E5%9D%80)
+    - [司机](#%E5%8F%B8%E6%9C%BA)
+    - [车辆](#%E8%BD%A6%E8%BE%86)
+    - [收款人](#%E6%94%B6%E6%AC%BE%E4%BA%BA)
 
 <!-- /TOC -->
 
@@ -113,7 +121,6 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 }
 ```
 
-
 ## 更新登陆凭证接口
 
 **简要描述:** 更新登陆凭证,更新后原token将失效
@@ -156,6 +163,7 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 }
 ```
 
+
 # 运单类接口
 
 ## 创建运单接口
@@ -174,7 +182,7 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 
 |名称|说明|类型|
 |---|---|---|
-|**orders**  <br>*必填*|运单列表  <br>**长度** : `1 - 50`|< [运单](#运单) > array|
+|**orders**  <br>*必填*|运单列表,一次最多50单  <br>**长度** : `1 - 50`|< [运单](#运单) > array|
 
 **返回示例**
 
@@ -196,9 +204,121 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 }
 ```
 
+
+# 基础信息类接口
+
+## 批量创建司机接口
+
+**简要描述:** 批量创建司机
+
+**请求 URL:** `/driver/batch_create`
+
+**请求方式:** POST
+
+**需要AccessToken:** 是
+
+**调用限制:** 60次/分钟
+
+**请求参数:**
+
+|名称|说明|类型|
+|---|---|---|
+|**drivers**  <br>*必填*|司机列表,单次最多50个  <br>**长度** : `1 - 50`|< [司机](#司机) > array|
+
+- 调用成功示例
+
+```java
+{
+    "code": 200,
+    "data": true,
+    "message": null
+}
+```
+- 调用失败示例
+
+```java
+{
+    "code": 500,
+    "message": "xxxxxxxx"
+}
+```
+
+## 批量创建车辆接口
+
+**简要描述:** 批量创建车辆
+
+**请求 URL:** `/vehicle/batch_create`
+
+**请求方式:** POST
+
+**需要AccessToken:** 是
+
+**调用限制:** 60次/分钟
+
+**请求参数:**
+
+|名称|说明|类型|
+|---|---|---|
+|**vehicles**  <br>*必填*|车辆列表,单次最多50个  <br>**长度** : `1 - 50`|< [车辆](#车辆) > array|
+
+- 调用成功示例
+
+```java
+{
+    "code": 200,
+    "data": true,
+    "message": null
+}
+```
+- 调用失败示例
+
+```java
+{
+    "code": 500,
+    "message": "xxxxxxxx"
+}
+```
+
+## 批量创建收款人接口
+
+**简要描述:** 批量创建收款人
+
+**请求 URL:** `/payee/batch_create`
+
+**请求方式:** POST
+
+**需要AccessToken:** 是
+
+**调用限制:** 60次/分钟
+
+**请求参数:**
+
+|名称|说明|类型|
+|---|---|---|
+|**payees**  <br>*必填*|收款人列表,单次最多50个  <br>**长度** : `1 - 50`|< [收款人](#收款人) > array|
+
+- 调用成功示例
+
+```java
+{
+    "code": 200,
+    "data": true,
+    "message": null
+}
+```
+- 调用失败示例
+
+```java
+{
+    "code": 500,
+    "message": "xxxxxxxx"
+}
+```
+
+
 # 财务类接口
 
-## 核销
+## 核销接口
 
 **简要描述:** 核销
 
@@ -241,11 +361,53 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 }
 ```
 
+## 支付并核销接口
+
+**简要描述:** 支付并核销
+
+**请求 URL:** `/writeoff/pay_and_writeoff`
+
+**请求方式:** POST
+
+**需要AccessToken:** 是
 
+**调用限制:** 60次/分钟
+
+**请求参数:**
 
-# 参数说明
+|名称|说明|类型|
+|---|---|---|
+|**carNumber**  <br>*必填*|车牌号码  <br>**长度** : `1 - 35`|string|
+|**customerOrderNumbers**  <br>*必填*|结算受理单列表|< string > array|
+|**driverName**  <br>*必填*|司机名称  <br>**长度** : `1 - 30`|string|
+|**driverPhone**  <br>*必填*|司机电话  <br>**长度** : `1 - 18`|string|
+|**payFreight**  <br>*必填*|支付金额  <br>**最小值** : `0`  <br>**最大值** : `999999`|number (double)|
+|**payType**  <br>*必填*|支付方式,1:油卡,2:现金,3:支付宝,4:微信,5:银行转账,6:其它|integer (int32)|
+|**note**  <br>*可选*|付款备注  <br>**长度** : `0 - 256`|string|
+
+- 调用成功示例
+
+```java
+{
+    "code": 200,
+    "data": true,
+    "message": null
+}
+```
+- 调用失败示例
+
+```java
+{
+    "code": 500,
+    "message": "xxxxxxxx"
+}
+```
+
+
+# 接口参数说明
 
 ## 运单
+
 |名称|说明|类型|
 |---|---|---|
 |**originalOrderNumber**  <br>*必填*|原始单号  <br>**长度** : `1 - 50`|string|
@@ -253,12 +415,12 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 |**carrier**  <br>*必填*|承运人|[承运人](#承运人)|
 |**consignerName**  <br>*必填*|发货人姓名  <br>**长度** : `1 - 45`|string|
 |**consignerPhone**  <br>*必填*|发货人电话  <br>**长度** : `1 - 20`|string|
-|**consignerIdCard**  <br>*必填*|发货人证件号  <br>**长度** : `1 - 35`|string|
 |**consignerAddress**  <br>*必填*|发货人地址|[地址](#地址)|
+|**consignerIdCard**  <br>*必填*|发货人证件号  <br>**长度** : `1 - 35`|string|
 |**consigneeName**  <br>*必填*|收货人姓名  <br>**长度** : `1 - 45`|string|
 |**consigneePhone**  <br>*必填*|收货人电话  <br>**长度** : `1 - 20`|string|
-|**consigneeIdCard**  <br>*可选*|收货人证件号  <br>**长度** : `0 - 35`|string|
 |**consigneeAddress**  <br>*必填*|收货人地址|[地址](#地址)|
+|**consigneeIdCard**  <br>*可选*|收货人证件号  <br>**长度** : `0 - 35`|string|
 |**appointArriveTime**  <br>*可选*|预约送达时间。时间戳|integer (int32)|
 |**cargoList**  <br>*可选*|货物列表|< [货物](#货物) > array|
 |**deliveryTime**  <br>*可选*|提货时间。时间戳|integer (int32)|
@@ -289,19 +451,18 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 |**shipperPayType**  <br>*可选*|上游运费支付方式. 1:现付;2:到付;3:回付;4:周结;5:月结;6:货款扣;7:季度结;8:在线支付;9:到付月结|integer (int32)|
 |**startAddress**  <br>*可选*|起始地  <br>**长度** : `0 - 20`|string|
 
-
 ## 货物
 
 |名称|说明|类型|
 |---|---|---|
 |**name**  <br>*必填*|货物名称  <br>**长度** : `1 - 150`|string|
-|**productModel**  <br>*可选*|货物备注  <br>**长度** : `0 - 100`|string|
+|**type**  <br>*必填*|货物类型|可选值请参考[《部网络货运信息交互系统代码集》](/resources/pdf/部网络货运信息交互系统代码集.pdf)|
+|**weight**  <br>*必填*|重量(千克)  <br>**最小值** : `0`  <br>**最大值** : `99999999`|number (double)|
 |**quantity**  <br>*可选*|件数  <br>**最小值** : `0`  <br>**最大值** : `999999`|number (double)|
 |**status**  <br>*可选*|货物状态|string|
-|**type**  <br>*必填*|货物类型|可选值请参考《部网络货运信息交互系统代码集》|
 |**value**  <br>*可选*|货值  <br>**最小值** : `0`  <br>**最大值** : `9999999`|number (double)|
 |**volume**  <br>*可选*|体积  <br>**最小值** : `0`  <br>**最大值** : `9999`|number (double)|
-|**weight**  <br>*必填*|重量(千克)  <br>**最小值** : `0`  <br>**最大值** : `99999999`|number (double)|
+|**productModel**  <br>*可选*|货物备注  <br>**长度** : `0 - 100`|string|
 |**note1**  <br>*可选*|自定义备注1|string|
 |**note2**  <br>*可选*|自定义备注2|string|
 |**note3**  <br>*可选*|自定义备注3|string|
@@ -325,8 +486,73 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 |名称|说明|类型|
 |---|---|---|
 |**address**  <br>*必填*|地址  <br>**长度** : `1 - 100`|string|
+|**province**  <br>*必填*|省。xx省,行政区划全称|string|
 |**city**  <br>*必填*|市。xx市,行政区划全称|string|
 |**district**  <br>*必填*|区/县。xx区/县,行政区划全称。直辖市省市区样例:北京市-北京市-朝阳区;省直辖市。样例:湖北省-仙桃市-仙桃市|string|
 |**lat**  <br>*可选*|纬度|number (double)|
 |**lng**  <br>*可选*|经度|number (double)|
-|**province**  <br>*必填*|省。xx省,行政区划全称|string|
+
+## 司机
+
+|名称|说明|类型|
+|---|---|---|
+|**name**  <br>*必填*|姓名  <br>**长度** : `1 - 20`|string|
+|**phoneNumber**  <br>*必填*|手机号  <br>**长度** : `11`|string|
+|**idCard**  <br>*必填*|身份证|string|
+|**driverLicenseIssuingAuthority**  <br>*必填*|驾驶证发证机关  <br>**长度** : `1 - 50`|string|
+|**driverLicenseNumber**  <br>*必填*|驾驶证编号  <br>**长度** : `1 - 18`|string|
+|**driverLicenseEndTime**  <br>*必填*|驾驶证有效期结束时间,时间戳,精确到秒|integer (int64)|
+|**driverLicenseStartTime**  <br>*必填*|驾驶证有效期开始时间,时间戳,精确到秒|integer (int64)|
+|**qualificationCertificateNumber**  <br>*必填*|从业资格证号  <br>**长度** : `1 - 19`|string|
+|**quasiDrivingModel**  <br>*必填*|准驾车型  <br>**长度** : `1 - 20`|string|
+|**associatedPayeeBankCardNumber**  <br>*可选*|关联收款人银行卡号。必须是收款人管理中已存在的银行卡号,否则不进行关联,但不会影响正常的创建|string|
+|**associatedVehicle**  <br>*可选*|关联车辆车牌号。必须是车辆管理中已存在并且审核通过的车,否则不进行关联,但不会影响正常的创建|string|
+|**idCardBackUrl**  <br>*可选*|身份证背面图片地址|string|
+|**idCardFrontUrl**  <br>*可选*|身份证正面图片地址|string|
+|**driverLicenseUrl**  <br>*可选*|驾驶证图片地址|string|
+|**qualificationCertificateUrlList**  <br>*可选*|从业资格证图片地址,最多传输4张|< string > array|
+|**verifyStatus**  <br>*可选*|审核状态,0:审核通过,1:审核不通过,默认:0|integer (int32)|
+|**note**  <br>*可选*|备注  <br>**长度** : `0 - 250`|string|
+
+## 车辆
+
+|名称|说明|类型|
+|---|---|---|
+|**licensePlateNumber**  <br>*必填*|车牌号  <br>**长度** : `1 - 10`|string|
+|**vehicleOwner**  <br>*必填*|车辆所有人  <br>**长度** : `1 - 50`|string|
+|**issuingAuthority**  <br>*必填*|发证机关  <br>**长度** : `1 - 50`|string|
+|**merchantName**  <br>*必填*|业户名称|string|
+|**natureOfUse**  <br>*必填*|使用性质  <br>**长度** : `1 - 20`|string|
+|**licensePlateColor**  <br>*必填*|车牌颜色,和车牌颜色代码对应,两个中必填一个,优先使用本字段的值,代码集请参考[《部网络货运信息交互系统代码集》](/resources/pdf/部网络货运信息交互系统代码集.pdf)|string|
+|**licensePlateColorCode**  <br>*可选*|车牌颜色代码,和车牌颜色对应|string|
+|**vehicleType**  <br>*必填*|车辆类型,和车辆类型代码对应,两个中必填一个,优先使用本字段的值,代码集请参考[《部网络货运信息交互系统代码集》](/resources/pdf/部网络货运信息交互系统代码集.pdf)|string|
+|**vehicleTypeCode**  <br>*可选*|车辆类型代码,和车辆类型对应|string|
+|**vehicleEnergyType**  <br>*必填*|车辆能源类型,和车辆能源类型代码对应,两个中必填一个,优先使用本字段的值,代码集请参考[《部网络货运信息交互系统代码集》](/resources/pdf/部网络货运信息交互系统代码集.pdf)|string|
+|**vehicleEnergyTypeCode**  <br>*可选*|车辆能源类型代码,和车辆能源类型对应|string|
+|**issueDate**  <br>*必填*|发证日期,时间戳,精确到秒|integer (int64)|
+|**registrationDate**  <br>*必填*|注册日期,时间戳,精确到秒|integer (int64)|
+|**roadTransportCertificate**  <br>*必填*|道路运输证号  <br>**长度** : `1 - 12`|string|
+|**roadTransportLicenseNumber**  <br>*必填*|道路运输经营许可证号|string|
+|**totalWeight**  <br>*必填*|总质量,单位:千克  <br>**最小值** : `1`|integer (int32)|
+|**approvedLoadWeight**  <br>*必填*|核定载质量,单位:千克  <br>**最小值** : `1`|integer (int32)|
+|**vehicleIDCode**  <br>*必填*|车辆识别代码  <br>**长度** : `1 - 20`|string|
+|**fileNumber**  <br>*可选*|档案编号  <br>**长度** : `0 - 20`|string|
+|**note**  <br>*可选*|备注  <br>**长度** : `0 - 250`|string|
+|**outlineHeight**  <br>*可选*|外廓高,单位:毫米  <br>**最小值** : `1`|integer (int32)|
+|**outlineLength**  <br>*可选*|外廓长,单位:毫米  <br>**最小值** : `1`|integer (int32)|
+|**outlineWidth**  <br>*可选*|外廓宽,单位:毫米  <br>**最小值** : `1`|integer (int32)|
+|**drivingLicenseUrlList**  <br>*可选*|行驶证照片,最多传输4张|< string > array|
+|**roadTransportPermitUrlList**  <br>*可选*|道路运输证照片,最多传输4张|< string > array|
+|**trailerLicenseNumber**  <br>*可选*|挂车牌照号  <br>**长度** : `0 - 10`|string|
+|**verifyStatus**  <br>*可选*|审核状态,0:审核通过,1:审核不通过,默认:0|integer (int32)|
+
+## 收款人
+
+|名称|说明|类型|
+|---|---|---|
+|**name**  <br>*必填*|银行开户名  <br>**长度** : `1 - 20`|string|
+|**bankCardNumber**  <br>*必填*|银行卡号|string|
+|**bankName**  <br>*必填*|开户银行,支持的银行请参考[《部网络货运信息交互系统代码集》](/resources/pdf/部网络货运信息交互系统代码集.pdf)|string|
+|**phoneNumber**  <br>*可选*|手机号  <br>**长度** : `11`|string|
+|**idCard**  <br>*可选*|身份证|string|
+|**note**  <br>*可选*|备注  <br>**长度** : `1 - 200`|string|