# 网络货运开放接口文档

------

<!-- TOC -->

- [网络货运开放接口文档](#%E7%BD%91%E7%BB%9C%E8%B4%A7%E8%BF%90%E5%BC%80%E6%94%BE%E6%8E%A5%E5%8F%A3%E6%96%87%E6%A1%A3)
    - [接口简介：](#%E6%8E%A5%E5%8F%A3%E7%AE%80%E4%BB%8B)
    - [相关说明请仔细阅读!：](#%E7%9B%B8%E5%85%B3%E8%AF%B4%E6%98%8E%E8%AF%B7%E4%BB%94%E7%BB%86%E9%98%85%E8%AF%BB)
- [接口凭证](#%E6%8E%A5%E5%8F%A3%E5%87%AD%E8%AF%81)
    - [获取登陆凭证接口](#%E8%8E%B7%E5%8F%96%E7%99%BB%E9%99%86%E5%87%AD%E8%AF%81%E6%8E%A5%E5%8F%A3)
    - [更新登陆凭证接口](#%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)
    - [更新运单接口](#%E6%9B%B4%E6%96%B0%E8%BF%90%E5%8D%95%E6%8E%A5%E5%8F%A3)
    - [签收运单接口](#%E7%AD%BE%E6%94%B6%E8%BF%90%E5%8D%95%E6%8E%A5%E5%8F%A3)
    - [查询运单接口](#%E6%9F%A5%E8%AF%A2%E8%BF%90%E5%8D%95%E6%8E%A5%E5%8F%A3)
    - [撤销运单接口](#%E6%92%A4%E9%94%80%E8%BF%90%E5%8D%95%E6%8E%A5%E5%8F%A3)
    - [创建撮合运单接口](#%E5%88%9B%E5%BB%BA%E6%92%AE%E5%90%88%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)
    - [修改司机信息接口](#%E4%BF%AE%E6%94%B9%E5%8F%B8%E6%9C%BA%E4%BF%A1%E6%81%AF%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)
    - [修改车辆信息接口](#%E4%BF%AE%E6%94%B9%E8%BD%A6%E8%BE%86%E4%BF%A1%E6%81%AF%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)
    - [修改收款人信息接口](#%E4%BF%AE%E6%94%B9%E6%94%B6%E6%AC%BE%E4%BA%BA%E4%BF%A1%E6%81%AF%E6%8E%A5%E5%8F%A3)
    - [创建经纪人接口](#%E5%88%9B%E5%BB%BA%E7%BB%8F%E7%BA%AA%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%E6%8E%A5%E5%8F%A3%E5%85%A8%E9%83%A8%E6%A0%B8%E9%94%80)
    - [撤销核销接口](#%E6%92%A4%E9%94%80%E6%A0%B8%E9%94%80%E6%8E%A5%E5%8F%A3)
    - [创建司机费用结算单接口](#%E5%88%9B%E5%BB%BA%E5%8F%B8%E6%9C%BA%E8%B4%B9%E7%94%A8%E7%BB%93%E7%AE%97%E5%8D%95%E6%8E%A5%E5%8F%A3)
    - [查询司机费用结算单信息接口](#%E6%9F%A5%E8%AF%A2%E5%8F%B8%E6%9C%BA%E8%B4%B9%E7%94%A8%E7%BB%93%E7%AE%97%E5%8D%95%E4%BF%A1%E6%81%AF%E6%8E%A5%E5%8F%A3)
    - [分笔核销司机费用结算单接口](#%E5%88%86%E7%AC%94%E6%A0%B8%E9%94%80%E5%8F%B8%E6%9C%BA%E8%B4%B9%E7%94%A8%E7%BB%93%E7%AE%97%E5%8D%95%E6%8E%A5%E5%8F%A3)
- [财务类接口撮合](#%E8%B4%A2%E5%8A%A1%E7%B1%BB%E6%8E%A5%E5%8F%A3%E6%92%AE%E5%90%88)
    - [创建司机费用结算单接口撮合](#%E5%88%9B%E5%BB%BA%E5%8F%B8%E6%9C%BA%E8%B4%B9%E7%94%A8%E7%BB%93%E7%AE%97%E5%8D%95%E6%8E%A5%E5%8F%A3%E6%92%AE%E5%90%88)
    - [查询司机费用结算单信息接口撮合](#%E6%9F%A5%E8%AF%A2%E5%8F%B8%E6%9C%BA%E8%B4%B9%E7%94%A8%E7%BB%93%E7%AE%97%E5%8D%95%E4%BF%A1%E6%81%AF%E6%8E%A5%E5%8F%A3%E6%92%AE%E5%90%88)
    - [分笔核销司机费用结算单接口撮合](#%E5%88%86%E7%AC%94%E6%A0%B8%E9%94%80%E5%8F%B8%E6%9C%BA%E8%B4%B9%E7%94%A8%E7%BB%93%E7%AE%97%E5%8D%95%E6%8E%A5%E5%8F%A3%E6%92%AE%E5%90%88)
- [合同类接口](#%E5%90%88%E5%90%8C%E7%B1%BB%E6%8E%A5%E5%8F%A3)
    - [创建承运人合同接口](#%E5%88%9B%E5%BB%BA%E6%89%BF%E8%BF%90%E4%BA%BA%E5%90%88%E5%90%8C%E6%8E%A5%E5%8F%A3)
    - [创建委托代收合同接口](#%E5%88%9B%E5%BB%BA%E5%A7%94%E6%89%98%E4%BB%A3%E6%94%B6%E5%90%88%E5%90%8C%E6%8E%A5%E5%8F%A3)
    - [创建撮合单票承运人合同接口](#%E5%88%9B%E5%BB%BA%E6%92%AE%E5%90%88%E5%8D%95%E7%A5%A8%E6%89%BF%E8%BF%90%E4%BA%BA%E5%90%88%E5%90%8C%E6%8E%A5%E5%8F%A3)
- [实名认证类接口](#%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E7%B1%BB%E6%8E%A5%E5%8F%A3)
    - [实名认证接口](#%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E6%8E%A5%E5%8F%A3)
- [位置信息类接口](#%E4%BD%8D%E7%BD%AE%E4%BF%A1%E6%81%AF%E7%B1%BB%E6%8E%A5%E5%8F%A3)
    - [上报运单轨迹接口](#%E4%B8%8A%E6%8A%A5%E8%BF%90%E5%8D%95%E8%BD%A8%E8%BF%B9%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)
    - [撮合运单](#%E6%92%AE%E5%90%88%E8%BF%90%E5%8D%95)
    - [货物](#%E8%B4%A7%E7%89%A9)
    - [承运人](#%E6%89%BF%E8%BF%90%E4%BA%BA)
    - [受理单收款人](#%E5%8F%97%E7%90%86%E5%8D%95%E6%94%B6%E6%AC%BE%E4%BA%BA)
    - [地址](#%E5%9C%B0%E5%9D%80)
    - [运单运费](#%E8%BF%90%E5%8D%95%E8%BF%90%E8%B4%B9)
    - [司机](#%E5%8F%B8%E6%9C%BA)
    - [车辆](#%E8%BD%A6%E8%BE%86)
    - [收款人](#%E6%94%B6%E6%AC%BE%E4%BA%BA)
    - [经纪人](#%E7%BB%8F%E7%BA%AA%E4%BA%BA)
    - [位置信息](#%E4%BD%8D%E7%BD%AE%E4%BF%A1%E6%81%AF)

<!-- /TOC -->

## 接口简介：

本文档为网络货运开放接口文档，对接流程为：
1. 注册并开通网络货运账号（正式环境账号联系我司实施或者商务获取）；
2. 使用网络货运的账号密码获取接口访问令牌（accessToken）；
3. 使用`accessToken`调用其他接口；

**请使用主账号获取对应的token再调用其他接口!!!**

## 相关说明(请仔细阅读!)：
1. **什么是主账号**：<br>即贵公司在我们系统中创建的第一个账号，其后所有的贵公司系统中的账号都是子账号。如果不知道自己是否使用的主账号或者主账号具体是哪个请联系相关负责人。

2. **接口统一URL地址**：<br>
**梵运**<br>
测试环境=https://openapi.wlhy.pre.kuaihuoyun.com ，正式环境=https://openapi.wlhy.56fanyun.com<br>
**快货运**<br>
测试环境=https://openapi.wlhy.pre.kuaihuoyun.com ，正式环境=https://openapi.wlhy.kuaihuoyun.com

3. **测试环境系统地址**：<br>
https://wlhy.pre.kuaihuoyun.com

4. **测试环境账号**：<br>联系我司对接负责人获取。账号并不互通，测试账号对应的是测试环境的域名，正式环境无法使用！

5. **调用接口方式**：<br>`URL` + `?access_token=生成的token`，参数传递使用JSON格式。
`Content-Type: application/json;charset=UTF-8`。例：
https://openapi.wlhy.pre.kuaihuoyun.com/order/create_order?access_token=fe12047e-52b1-418c-848c-d08a885095a5
**请勿将请求参数拼接在URL中传递！**

6. **调试接口**：<br>推荐使用Postman，或者访问接口URL，会跳转至调试界面

7. **时间格式**：<br>如无特殊说明，接口中所有时间均使用时间戳，精确到秒

8. **调用限制**：<br>为防止恶意攻击和滥用，接口都加上了调用限制，不同接口限制不同，请参考接口中调用限制的相关说明。例：60次/分钟，表示一分钟内最多请求60次，超过限制会拒绝请求，返回`操作太频繁`。

9. **状态码**：

|状态码|说明|
|:---:|---|
|200|调用接口成功|
|401|授权失败，需要重新登陆获取access_token|
|404|接口不存在，请检查调用的接口地址，协议的格式是否正确|
|500|服务异常，具体错误原因会在返回结果中说明|

10. **返回字段**：

|名称|说明|
|:---:|---|
|code|状态码|
|data|返回数据，接口调用成功（状态码为 200）之后返回的数据|
|message|错误信息，当接口调用失败（状态码为 非200）时，返回的错误信息，调用成功时返回null|


# 接口凭证

## 获取登陆凭证接口

**简要描述：** 获取登陆凭证，accessToken有效期`72小时`，refreshToken有效期`100天`，有效期内获取token返回的结果一样，accessToken到期后建议使用refreshToken进行刷新，而不是使用用户名密码重新获取

**请求 URL：** `/user/generate_access_token`

**请求方式：** POST

**需要AccessToken：** 否

**调用限制：** 60次/分钟

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**userName**  <br>*必填*|账号|string|
|**password**  <br>*必填*|密码|string|

**请求示例**

```shell
curl -H "Content-Type:application/json" -X POST --data
'{
    "userName": "abc",
    "password": "12345"
}'
https://openapi.wlhy.pre.kuaihuoyun.com/user/generate_access_token
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "message": null,
    "data": {
        "accessToken": "9d0dfe02-2349-421c-90ec-4b9ea174701b",
        "refreshToken": "9f8326bc-c29f-4a28-a512-26caa1a9850a"
    }
}
```
- 调用失败示例

```java
{
    "code": 500,
    "message": "账号或密码不正确"
}
```

## 更新登陆凭证接口

**简要描述：** 更新登陆凭证，会同时更新accessToken和refreshToken，更新后原accessToken和refreshToken将失效

**请求 URL：** `/user/refresh_access_token`

**请求方式：** POST

**需要AccessToken：** 否

**调用限制：** 60次/分钟

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**userName**  <br>*必填*|账号|string|
|**refreshToken**  <br>*必填*|刷新凭证|string|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
    "userName": "userName",
    "refreshToken": "9f8326bc-c29f-4a28-a512-26caa1a9850a"
}'
https://openapi.wlhy.pre.kuaihuoyun.com/user/refresh_access_token
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "message": null,
    "data": {
        "accessToken": "9d0dfe02-2349-421c-90ec-4b9ea174701b",
        "refreshToken": "9f8326bc-c29f-4a28-a512-26caa1a9850a"
    }
}
```
- 调用失败示例

```java
{
    "code": 500,
    "message": "账号或刷新凭证不正确"
}
```


# 运单类接口

## 创建运单接口

**简要描述：** 开单

**请求 URL：** `/order/create_order`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 3次/秒

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**orders**  <br>*必填*|运单列表，一次最多50单  <br>**长度** : `1 - 50`|< [运单](#运单) > array|
|**organizationName**  <br>*可选*|组织机构名称，会创建至对应组织机构下，默认创建到总部|string|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
   "orders": [
     {
       "appointArriveTime": 1604973799,
       "businessType": "干线普货运输",
 	  "startAddress": "浙江省滨江区滨文路100号",
 	  "endAddress": "浙江省西湖区计量大楼",
 	  "paymentCollect": 100,
 	  "receiptCount": 1,
       "cargoList": [
         {
           "name": "煤炭",
           "note1": "",
           "note2": "",
           "note3": "",
           "note4": "",
           "note5": "",
           "note6": "",
           "productModel": "煤炭",
           "quantity": 100,
           "type": "煤炭及制品",
           "value": 10000,
           "volume": 66.6,
           "weight": 9
         }
       ],
       "carrier": {
         "carNumber": "浙D516110",
         "driverFreight": 16000,
         "driverName": "程咬金",
         "driverPhone": "13521020022",
         "insuranceCompany": "",
         "insuranceNumber": ""
       },
       "consigneeAddress": {
         "address": "计量大楼",
         "city": "杭州市",
         "district": "西湖区",
         "lat": 30.343928,
         "lng": 120.065772,
         "province": "浙江省"
       },
       "consigneeIdCard": "110101199003076157",
       "consigneeName": "李丽",
       "consigneePhone": "13577229900",
       "consignerAddress": {
         "address": "滨文路100号",
         "city": "杭州市",
         "district": "滨江区",
         "lat": 30.168328,
         "lng": 120.190002,
         "province": "浙江省"
       },
       "consignerIdCard": "110101199003071137",
       "consignerName": "金全",
       "consignerPhone": "13599229009",
       "deliveryTime": 1604980800,
       "deliveryType": 2,
       "freightIn": {
         "amount": 100,
         "payType": 1
       },
       "note1": "",
       "note2": "",
       "note3": "",
       "note4": "",
       "note5": "",
       "note6": "",
       "note7": "",
       "note8": "",
       "note9": "",
 	  "note10": "",
 	  "note11": "",
 	  "note12": "",
       "openTime": 1604970800,
       "originalOrderNumber": "KH10001",
       "payee": {
         "bankCardNumber": "6227002470170278192",
         "bankName": "建设银行",
         "idCard": "110101199003079673",
         "name": "林曦",
         "phoneNumber": "15899125566"
       },
       "remarks": "",
       "salesman": "韩风",
       "salesmanPhone": "15678102991",
       "settlementName": "",
       "settlementPhone": "",
       "shipperPay": 10,
       "shipperPayType": 1
     }
   ],
   "organizationName": "总部"
 }'
https://openapi.wlhy.pre.kuaihuoyun.com/order/create_order?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": ["S2004221802969563"],
    "message": null    
}
```

- 调用失败示例

```java
{
    "code": 500,
    "message": "订单创建失败"
}
```


## 更新运单接口

**简要描述：** 更新运单

**请求 URL：** `/order/update_order`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 3次/秒

**请求参数：**

请参考：[运单](#运单)

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "orderNumber": "S2010291432590922",
  "appointArriveTime": 1604973799,
  "businessType": "干线普货运输",
	"startAddress": "浙江省滨江区滨文路100号",
	"endAddress": "浙江省西湖区计量大楼",
	"paymentCollect": 100,
	"receiptCount": 1,
  "cargoList": [
    {
      "name": "煤炭",
      "note1": "",
      "note2": "",
      "note3": "",
      "note4": "",
      "note5": "",
      "note6": "",
      "productModel": "煤炭",
      "quantity": 100,
      "type": "煤炭及制品",
      "value": 10000,
      "volume": 66.6,
      "weight": 9
    }
  ],
  "carrier": {
    "carNumber": "浙D516110",
    "driverFreight": 16000,
    "driverName": "程咬金",
    "driverPhone": "13521020022",
    "insuranceCompany": "",
    "insuranceNumber": ""
  },
  "consigneeAddress": {
    "address": "计量大楼",
    "city": "杭州市",
    "district": "西湖区",
    "lat": 30.343928,
    "lng": 120.065772, 
    "province": "浙江省"
  },
  "consigneeIdCard": "110101199003076157",
  "consigneeName": "李丽",
  "consigneePhone": "13577229900",
  "consignerAddress": {
    "address": "滨文路100号",
    "city": "杭州市",
    "district": "滨江区",
    "lat": 30.168328,
    "lng": 120.190002,
    "province": "浙江省"
  },
  "consignerIdCard": "110101199003071137",
  "consignerName": "金全",
  "consignerPhone": "13599229009",
  "deliveryTime": 1604980800,
  "deliveryType": 2,
  "freightIn": {
    "amount": 100,
    "payType": 1
  },
  "note1": "",
  "note2": "",
  "note3": "",
  "note4": "",
  "note5": "",
  "note6": "",
  "note7": "",
  "note8": "",
  "note9": "",
	"note10": "",
	"note11": "",
	"note12": "",
  "openTime": 1604970800,
  "originalOrderNumber": "KH10001",
  "payee": {
    "bankCardNumber": "6227002470170278192",
    "bankName": "建设银行",
    "idCard": "110101199003079673",
    "name": "林曦",
    "phoneNumber": "15899125566"
  },
  "remarks": "",
  "salesman": "韩风",
  "salesmanPhone": "15678102991",
  "settlementName": "",
  "settlementPhone": "",
  "shipperPay": 10,
  "shipperPayType": 1
}'
https://openapi.wlhy.pre.kuaihuoyun.com/order/update_order?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```

- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```


## 签收运单接口

**简要描述：** 签收运单

**请求 URL：** `/order/signOff_order`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 3次/秒

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**orderNumbers**  <br>*必填*|运单号列表，一次最多50单  <br>**长度** : `1 - 50`|< string > array|
|**signer**  <br>*可选*|签收人  <br>**长度** : `0 - 20`|string|
|**signTime**  <br>*可选*|签收时间，时间戳，精确到秒|integer (int32)|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "orderNumbers": ["S2010291432590922"],
  "signer": "签收人",
  "signTime": 1604970800
}'
https://openapi.wlhy.pre.kuaihuoyun.com/order/signOff_order?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```

- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```


## 查询运单接口

**简要描述：** 查询运单

**请求 URL：** `/order/query_order`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 5次/秒

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**page**  <br>*必填*|当前页  <br>**最小值** : `1`  <br>**最大值** : `1000`|string|
|**size**  <br>*必填*|单页数量  <br>**最小值** : `1`  <br>**最大值** : `50`|string|
|**orderNumbers**  <br>*可选*|运单号列表，一次最多50单  <br>**长度** : `1 - 50`|< string > array|
|**timeType**  <br>*可选*|时间类型  <br>**可选值** : `created(创建时间),opened(开单时间),signed(完成时间),arrivedTime(到达时间),appointArriveTime(预约送达时间)`|string|
|**beginDate**  <br>*可选*|开始时间 <br>**格式** : `yyyy-MM-dd HH:mm:ss`|string|
|**endDate**  <br>*可选*|结束时间 <br>**格式** : `yyyy-MM-dd HH:mm:ss`|string|
|**originalOrderNumber**  <br>*可选*|客户单号，支持模糊搜索|string|
|**startAddress**  <br>*可选*|起始地 <br>**长度** : `0 - 20`|string|
|**endAddress**  <br>*可选*|目的地 <br>**长度** : `0 - 20`|string|
|**consignerName**  <br>*可选*|发货方姓名 <br>**长度** : `0 - 45`|string|
|**consignerPhone**  <br>*可选*|发货方电话 <br>**长度** : `0 - 20`|string|
|**consigneeName**  <br>*可选*|收货方姓名 <br>**长度** : `0 - 45`|string|
|**consigneePhone**  <br>*可选*|收货方电话 <br>**长度** : `0 - 20`|string|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
    "page": 1,
    "size": 10
 }' 
 https://openapi.wlhy.pre.kuaihuoyun.com/order/query_order?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
  "code": 200,
  "message": null,
  "data": {
    "page": 1,
    "size": 1,
    "total": 8349,
    "elements": [
      {
        "order": {
          "id": "60082ce6a75705000ae6b3f9",
          "uid": "5e23cbe0e4b0e777fc3d57dc",
          "createUid": "5e23cbe0e4b0e777fc3d57dc",
          "createUserId": "15957174145",
          "createUsername": "梵梵dev",
          "businessFlag": 1,                                // 1-自营，2-自营平台，3-撮合
          "number": "S2101202115350022",                    // 受理单号
          "originalOrderNumber": "S2101202115350022",       // 客户单号
          "openTime": 1611146760,                           // 开单时间(s)
          "deliveryTime": null,                             // 提货时间(s)
          "deliveryType": null,                             // 提送类型
          "appointArriveTime": null,                        // 预约送达时间(s)
          "startAddress": null,                             // 起点地址
          "endAddress": null,                               // 终点地址
          "consigner": {                                    // 发货人信息
            "name": "宁波公运集团",                           // 发货人姓名或公司
            "phone": "6615999",                             // 发货人电话
            "idNO": "91330200144061515D",                   // 发货人身份证或统一社会信用代码
            "address": {                                    // 发货人地址
              "province": "浙江省",
              "city": "宁波市",
              "district": "北仑区",
              "detail": "浙江省宁波市北仑区大润发(北仑店)",
              "lng": 121.817376,
              "lat": 29.895562
            }
          },
          "consignee": {                                    // 收货人信息
            "name": "温温gg",                                // 收货人姓名
            "phone": "6688888",                             // 收货人电话
            "idNO": "",                                     // 收货人身份证或统一社会信用代码
            "address": {                                    // 收货人地址
              "province": "浙江省",
              "city": "温州市",
              "district": "鹿城区",
              "detail": "浙江省温州市鹿城区绿城·温州鹿城广场",
              "lng": 120.682252,
              "lat": 28.018501
            }
          },
          "abnormal": null,                                 // 是否异常
          "shipper": "贵州梵运华为云15957174145",              // 托运方
          "freightIn": {                                    // 运费信息
            "payType": 1,                                   // 支付方式：1现付、2到付、3回付、4周结、5月结、6贷款扣、7季度结、8在线支付、9到付月结
            "amount": 1888                                  // 运费金额
          },
          "serviceFee": 159.06,                             // 服务费
          "uppay1": null,                                   // 自定义费用1
          "uppay2": null,                                   // 自定义费用2
          "uppay3": null,                                   // 自定义费用3
          "uppay4": null,                                   // 自定义费用4
          "uppay5": null,                                   // 自定义费用5
          "uppay6": null,                                   // 自定义费用6
          "uppay7": null,                                   // 自定义费用7
          "uppay8": null,                                   // 自定义费用8
          "uppay9": null,                                   // 自定义费用9
          "uppay10": null,                                  // 自定义费用10
          "uppay11": null,                                  // 自定义费用11
          "uppay12": null,                                  // 自定义费用12
          "paymentCollect": null,                           // 代收货款
          "receiptCount": 1,                                // 回单数量
          "remarks": "",                                    // 备注
          "note1": "",                                      // 自定义备注1
          "note2": "",                                      // 自定义备注2
          "note3": "",                                      // 自定义备注3
          "note4": null,                                    // 自定义备注4
          "note5": null,                                    // 自定义备注5
          "note6": null,                                    // 自定义备注6
          "note7": null,                                    // 自定义备注7
          "note8": null,                                    // 自定义备注8
          "note9": null,                                    // 自定义备注9
          "note10": null,                                   // 自定义备注10
          "note11": null,                                   // 自定义备注11
          "note12": null,                                   // 自定义备注12
          "option1": "下拉选项1",                            // 自定义选项1
          "option2": null,                                  // 自定义选项2
          "option3": null,                                  // 自定义选项3
          "extendFields": null,                             // 扩展字段
          "createOrganizationPath": "0",                    // 创建人组织机构
          "createOrganizationType": null,                   // 开单机构类型
          "ownerOrganizationPath": "0",                     // 拥有人组织机构
          "assignOrganizationPaths": [                      // 所有拥有权限组织机构
            "0"
          ],
          "receiveOrganizationPath": null,                  // 接收人组织机构
          "source": 1,                                      // 来源，1手工录入2标准导入3客户下单4接口导入5合并导入6任务订单7受理单
          "state": 3000,                                    // 状态，0:已撤销 1000:待处理 1100:已签约 2000:进行中 2100:待确认完成 3000:已完成
          "settlementParty": 1,                             // 结算方，1：发货方 2：收货方
          "settlementName": "宁波公运集团",                   // 结算方名称
          "settlementPhone": "6615999",                     // 结算方电话
          "totalFreightIn": 2047.06,                        // 总上游费用
          "freightInReceived": null,                        // 已收上游费用
          "freightInUnreceived": 2047.06,                   // 未收
          "freightInState": null,                           // 上游运费收取状态
          "freightInTime": null,                            // 上游运费收取时间
          "paymentCollectState": null,                      // 代收货款状态
          "paymentCollectReceived": null,                   // 已收代收费用
          "paymentCollectTime": null,                       // 代收收取时间
          "paymentCollectWriteoffTime": null,               // 代收核销时间
          "customerOrderPrintStatus": null,                 // 受理单打印状态 1：已打印，0：未打印
          "customerOrderTipsPrintStatus": null,             // 受理单打印状态 1：已打印，0：未打印
          "receiptState": null,                             // 回单状态 1待回收2已回收3已发放4回单上传
          "receiptCallbacker": null,                        // 回单回收人
          "receiptCallbackTime": null,                      // 回单回收时间
          "receiptSender": null,                            // 回单发放人
          "receiptSentTime": null,                          // 回单发放时间
          "orderPackNumber": "P2101202115350064",           // 车次号
          "receivedTime": 1611148518,                       // 接单(指派)时间
          "publishTime": null,                              // 下发时间(装货时间)
          "loadAddress": null,                              // 装货地址
          "signAddress": null,                              // 签收地址
          "lastSignTime": 1611148605,                       // 最后一段签收时间
          "driverSignTime": 1611148605,                     // 司机签收时间
          "signer": null,                                   // 签收人
          "reachStation": null,                             // 已到达站
          "nextStation": null,                              // 下一站
          "lastUploadAddress": null,                        // 上一次上传坐标信息
          "lastUploadTime": null,                           // 上一次上传时间
          "bindDevices": [                                  // 设备绑定
            "浙A00002"
          ],
          "currentBindDevice": "浙A00002",                   // 当前绑定的设备
          "lastDevice": "浙A00002",                          // 最后绑定的设备
          "settlementNumber": null,                         // 结算单号
          "writeoffSettlementNumber": null,                 // 核销单号（分笔付最后一个核销单号）
          "writeoffSettlementTime": null,                   // 核销时间
          "mileage": null,                                  // 行驶里程(千米)
          "duration": null,                                 // 行驶时间(秒)
          "mileageEstimated": 334,                          // 预估里程
          "durationEstimated": 14823,                       // 预估时间(秒)
          "estimatedArriveTime": 1611148605,                // 预计到达时间
          "estimatedLeftMiles": null,                       // 剩余里程
          "lastAddress": null,                              // 最后一个定位点
          "lastGpsLocation": null,                          // 最后一个定位点
          "lastGpsTime": null,                              // 最后一个定位时间
          "departureTime": null,                            // 出发时间
          "departureTimeStatus": null,                      // 提货时效
          "arrivedTime": null,                              // 到达时间
          "arrivedTimeStatus": null,                        // 到达时效
          "humidityAlarmMinValue": null,                    // 预警最小湿度
          "humidityAlarmMaxValue": null,                    // 预警最大湿度
          "temperatureAlarmMinValue": null,                 // 预警最小温度
          "temperatureAlarmMaxValue": null,                 // 预警最大温度
          "salesman": null,                                 // 业务员
          "salesmanPhone": null,                            // 业务员电话
          "businessType": "其他",                            // 业务类型
          "businessTypeCode": "1003999",                    // 业务类型代码
          "project": "",                                    // 项目
          "projectNumber": "",                              // 项目编号
          "lineNumber": "",                                 // 线路编号
          "lineName": null,                                 // 线路名称
          "customerOrderDispatch": {                        // 调度信息
            "carNumber": "浙A00002",                        // 车牌号码
            "driverPhone": "15658033252",                   // 司机电话
            "driverName": "胡伟园",                          // 司机姓名
            "driverLicense": "330226197808230048",          // 司机身份证
            "driverFreight": 1222,                          // 司机运费
            "insuranceCode": "",                            // 保险公司代码
            "insuranceCompany": "",                         // 保险公司
            "insuranceNumber": ""                           // 保险单号
          },
          "driverFeePayee": {                               // 收款人信息
            "accountType": 0,                               // 账户类型，0 银行账户， 1在线收款账户
            "name": "胡伟园",                                // 收款人姓名
            "bankCode": "CMBC",                             // 银行代码
            "bankName": "招商银行",                          // 银行
            "bankCardNumber": "6214855719529493",           // 银行卡号
            "phoneNumber": "",                              // 收款人手机号
            "idCard": "330226197808230048",                 // 收款人身份证
            "accountNo": null                               // 网商卡号
          },
          "driverFeeSettlementNumber": "CJ2101202117828805",        // 司机费用结算单
          "driverFeeSettlementContractNumber": null,                // 司机费用结算合同单号
          "driverFeeSettlementContractTime": "1611148623",          // 司机费用结算合同校验时间
          "driverFeeWriteOffNumber": "CH2101202117828802",          // 司机费用核销单号，分笔付是最后支付的核销单号
          "driverFeeWriteOffTime": 1611148623,                      // 司机费用核销时间，分笔付是最后支付的核销时间
          "driverFreightPaid": 1222,                                // 已付司机费用
          "driverFeeSettlementStatus": 1,                           // 司机费用核销状态，0未核销1已核销2部分核销10支付中11支付失败
          "driverFeePaidMeans": 1,                                  // 收款账户类型
          "driverFeeInvoiceState": null,                            // 司机费用开票状态，1已登记2已开票3已撤销登记4已撤销开票5已登记付款中6已登记付款成功7已撤销登记退款中
                                                                    //               8登记中9登记失败12开票失败13不开票14税额异常15开票中16发票作废17发票冲红
          "driverFeeRegisterNumber": null,                          // 司机费用登记号
          "driverFeeRegisterTime": null,                            // 司机开票-登记时间(成功/失败)
          "driverFeeInvoiceTime": null,                             // 司机开票-开票时间(成功)
          "driverFeePayState": null,                                // 1 - 支付中，2 - 支付成功；3 - 支付失败
          "customerInvoiceRegisterNumber": null,                    // 客户开票 - 凭证编号
          "customerInvoiceRegisterTime": null,                      // 客户开票 - 已登记时间
          "consignerSalesman": false,                               // 业务员是否是发货人
          "consigneeSalesman": false,                               // 业务员是否是收货人
          "contractNumber": "WLHY-CYR-20200720-09657",              // 合同号
          "contractType": 1,                                        // 合同类型，1普通2电子
          "remainingWorkTimeStr": "",                               // 剩余工作时长
          "nullifyTime": null,                                      // 作废时间
          "nullifyContent": null,                                   // 作废内容
          "nullifyOperator": null,                                  // 操作人
          "abnormalAppealState": 2,                                 // 申诉状态
          "noInvoiceReason": null,                                  // 不开票原因
          "upPayTotal": 0,                                          // 自定义费用总和
          "progress": null,                                         // 进度
          "leftMileage": null,                                      // 实际里程距预估里程还有多少
          "departured": false,                                      // 是否出发
          "arrived": false,                                         // 是否到达
          "finished": true,                                         // 是否完成
          "bindStatusName": "已解绑",                                // 设备绑定状态名称
          "driverFreightUnPaid": 0,                                 // 未付的司机费用
          "payingToDriver": null,                                   // 是否司机收款
          "created": 1611148518,                                    // 创建时间(s)
          "updated": 1611148717,                                    // 修改时间(s)
          "makeUp": false                                           // 是否为补单
        },
        "cargoes": [                                                // 货物信息
          {
            "uid": "5e23cbe0e4b0e777fc3d57dc",
            "customerOrderId": "60082ce6a75705000ae6b3f9",          // 订单id
            "customerOrderNumber": "S2101202115350022",             // 订单编号
            "name": "宁波梅干菜",                                     // 货物名称
            "quantity": null,                                       // 件数
            "weight": 20000,                                        // 重量(千克)
            "volume": null,                                         // 体积
            "unloadQuantity": null,                                 // 卸货件数
            "unloadWeight": 20000,                                  // 卸货重量(千克)
            "unloadVolume": null,                                   // 卸货体积
            "value": null,                                          // 货值
            "remarks": "",                                          // 备注
            "type": "其他",                                          // 货物类型
            "typeCode": "1700",                                     // 货物类型代码
            "note1": "",                                            // 自定义备注1
            "note2": "",                                            // 自定义备注2
            "note3": "",                                            // 自定义备注3
            "note4": "",                                            // 自定义备注4
            "note5": "",                                            // 自定义备注5
            "note6": "",                                            // 自定义备注6
            "created": 1611148518                                   // 货物创建时间
          }
        ]
      }
    ],
    "totalPagesCount": 8349
  }
}
```

- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```


## 撤销运单接口

**简要描述：** 撤销运单

**请求 URL：** `/order/cancel_order`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 3次/秒

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**orderNumbers**  <br>*必填*|运单号列表，一次最多50单  <br>**长度** : `1 - 50`|< string > array|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "orderNumbers": ["S2010291432590922"]
}'
https://openapi.wlhy.pre.kuaihuoyun.com/order/cancel_order?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```

- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```

## 创建撮合运单接口

**简要描述：** 撮合开单

**请求 URL：** `/order_match_up/create_order_match_up`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 3次/秒

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**orderMatchUpList**  <br>*必填*|撮合运单列表，单次最多50个  <br>**长度** : `1 - 50`|< [撮合运单](#撮合运单) > array|
|**organizationName**  <br>*必填*|组织机构名称，会创建至对应组织机构下|string|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "orderMatchUpList": [
    {
      "appointArriveTime": 1604973799,
      "businessType": "干线普货运输",
	    "startAddress": "浙江省滨江区滨文路100号",
	    "endAddress": "浙江省西湖区计量大楼",
	    "paymentCollect": 100,
	    "receiptCount": 1,
      "cargoList": [
        {
          "name": "煤炭",
          "note1": "",
          "note2": "",
          "note3": "",
          "note4": "",
          "note5": "",
          "note6": "",
          "productModel": "煤炭",
          "quantity": 100,
          "type": "煤炭及制品",
          "value": 10000,
          "volume": 66.6,
          "weight": 9
        }
      ],
      "carrier": {
        "carNumber": "浙D516110",
        "driverFreight": 16000,
        "driverName": "程咬金",
        "driverPhone": "13521020022",
        "insuranceCompany": "",
        "insuranceNumber": ""
      },
      "consigneeAddress": {
        "address": "计量大楼",
        "city": "杭州市",
        "district": "西湖区",
        "lat": 30.343928,
        "lng": 120.065772,
        "province": "浙江省"
      },
      "consigneeIdCard": "110101199003076157",
      "consigneeName": "李丽",
      "consigneePhone": "13577229900",
      "consignerAddress": {
        "address": "滨文路100号",
        "city": "杭州市",
        "district": "滨江区",
        "lat": 30.168328,
        "lng": 120.190002,
        "province": "浙江省"
      },
      "consignerIdCard": "110101199003071137",
      "consignerName": "金全",
      "consignerPhone": "13599229009",
      "deliveryTime": 1604980800,
      "deliveryType": 2,
      "note1": "",
      "note2": "",
      "note3": "",
      "note4": "",
      "note5": "",
      "note6": "",
      "note7": "",
      "note8": "",
      "note9": "",
	    "note10": "",
	    "note11": "",
	    "note12": "",
      "openTime": 1604970800,
      "originalOrderNumber": "KH10001",
      "payee": {
        "bankCardNumber": "6227002470170278192",
        "bankName": "建设银行",
        "idCard": "110101199003079673",
        "name": "林曦",
        "phoneNumber": "15899125566"
      },
      "remarks": "",
      "salesman": "韩风",
      "salesmanPhone": "15678102991"
    }
  ],
  "organizationName": "总部"
}'
https://openapi.wlhy.pre.kuaihuoyun.com/order_match_up/create_order_match_up?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```

- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```

# 基础信息类接口

## 批量创建司机接口

**简要描述：** 批量创建司机

**请求 URL：** `/driver/batch_create`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 3次/秒

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**drivers**  <br>*必填*|司机列表，单次最多50个  <br>**长度** : `1 - 50`|< [司机](#司机) > array|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "drivers": [
    {
      "driverLicenseEndTime": 1635465600,
      "driverLicenseIssuingAuthority": "机关",
      "driverLicenseNumber": "110101198803078738",
      "driverLicenseStartTime": 1603929600,
      "driverLicenseUrl": "https://oss.ali.56fanyun.com/ttms/b0a06471d4434004b4543c4339431111.jpeg",
      "idCard": "110101198803078738",
      "idCardAddress": "地址",
      "idCardBackUrl": "https://oss.ali.56fanyun.com/ttms/5ca69f27c8844efc8de003cfbcbd4a30.jpg",
      "idCardFrontUrl": "https://oss.ali.56fanyun.com/ttms/a80fa112d8764c08b7b40e90318e917d.jpeg",
      "name": "朱元璋",
      "note": "",
      "organizationName": "总部",
      "phoneNumber": "18256999988",
      "qualificationCertificateNumber": "110101198803078738",
      "qualificationCertificateUrlList": [
        ""
      ],
      "quasiDrivingModel": "C2"
    }
  ]
}'
https://openapi.wlhy.pre.kuaihuoyun.com/driver/batch_create?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

注意事项
1. 从业资格证号需为身份证或18位数字
2. 驾驶证编号需为身份证或18位数字
3. 司机姓名和身份证号必须真实一致

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```

- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```

## 修改司机信息接口

**简要描述：** 修改司机信息，根据唯一标识更新对应司机的信息，该接口为覆盖更新，故未变更的字段也需要传入，否则会置空

**请求 URL：** `/driver/update`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 3次/秒

**请求参数：**

请参考：[司机](#司机)

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "driverLicenseEndTime": 1635465600,
  "driverLicenseIssuingAuthority": "机关",
  "driverLicenseNumber": "110101198803078738",
  "driverLicenseStartTime": 1603929600,
  "driverLicenseUrl": "https://oss.ali.56fanyun.com/ttms/b0a06471d4434004b4543c4339431111.jpeg",
  "idCard": "110101198803078738",
  "idCardAddress": "地址",
  "idCardBackUrl": "https://oss.ali.56fanyun.com/ttms/5ca69f27c8844efc8de003cfbcbd4a30.jpg",
  "idCardFrontUrl": "https://oss.ali.56fanyun.com/ttms/a80fa112d8764c08b7b40e90318e917d.jpeg",
  "name": "朱元璋",
  "note": "",
  "organizationName": "总部",
  "phoneNumber": "18256999988",
  "qualificationCertificateNumber": "110101198803078738",
  "qualificationCertificateUrlList": [
    ""
  ],
  "quasiDrivingModel": "C2"
}'
https://openapi.wlhy.pre.kuaihuoyun.com/driver/update?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```

- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```


## 批量创建车辆接口

**简要描述：** 批量创建车辆

**请求 URL：** `/vehicle/batch_create`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 3次/秒

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**vehicles**  <br>*必填*|车辆列表，单次最多50个  <br>**长度** : `1 - 50`|< [车辆](#车辆) > array|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "vehicles": [
    {
      "approvedLoadWeight": 20700,
      "drivingLicenseUrlList": [
        "https://oss.56fanyun.com/ttms/fda0e5e00e6f4a87b662e9b6d807b706.jpeg"
      ],
      "fileNumber": "浙N99999",
      "issueDate": 1423440000,
      "issuingAuthority": "交通局",
      "licensePlateColorCode": "3",
      "licensePlateNumber": "浙N99999",
      "merchantName": "业户",
      "natureOfUse": "货运",
      "note": "",
      "organizationName": "总部",
      "outlineHeight": 1850,
      "outlineLength": 1019,
      "outlineWidth": 2510,
      "registrationDate": 1394409600,
      "roadTransportCertificate": "浙N99999",
      "roadTransportLicenseNumber": "浙N99999",
      "roadTransportPermitUrlList": [
        ""
      ],
      "totalWeight": 30000,
      "trailerLicenseNumber": "浙N99999",
      "vehicleEnergyTypeCode": "B",
      "vehicleIDCode": "LA71ANH40E0043123",
      "vehicleOwner": "周东辉",
      "vehicleTypeCode": "H14"
    }
  ]
}'
https://openapi.wlhy.pre.kuaihuoyun.com/vehicle/batch_create?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

注意事项
1. 道路运输证号必须为6-20位数字
2. 道路运输经营许可证号必须为12-20位数字
3. 道路运输证号和道路运输经营许可证号不能相等
4. 发证机关只允许汉字且不能超过50个字
5. 核定载质量必须大于等于100
6. 核定载质量必须小于等于总质量

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```

- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```


## 修改车辆信息接口

**简要描述：** 修改车辆信息，根据唯一标识更新对应车辆的信息，该接口为覆盖更新，故未变更的字段也需要传入，否则会置空

**请求 URL：** `/vehicle/update`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 3次/秒

**请求参数：**

请参考：[车辆](#车辆)

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "approvedLoadWeight": 20700,
  "drivingLicenseUrlList": [
    "https://oss.56fanyun.com/ttms/fda0e5e00e6f4a87b662e9b6d807b706.jpeg"
  ],
  "fileNumber": "浙N99999",
  "issueDate": 1423440000,
  "issuingAuthority": "交通局",
  "licensePlateColorCode": "3",
  "licensePlateNumber": "浙N99999",
  "merchantName": "业户",
  "natureOfUse": "货运",
  "note": "",
  "organizationName": "总部",
  "outlineHeight": 1850,
  "outlineLength": 1019,
  "outlineWidth": 2510,
  "registrationDate": 1394409600,
  "roadTransportCertificate": "浙N99999",
  "roadTransportLicenseNumber": "浙N99999",
  "roadTransportPermitUrlList": [
    ""
  ],
  "totalWeight": 30000,
  "trailerLicenseNumber": "浙N99999",
  "vehicleEnergyTypeCode": "B",
  "vehicleIDCode": "LA71ANH40E0043123",
  "vehicleOwner": "周东辉",
  "vehicleTypeCode": "H14"
}'
https://openapi.wlhy.pre.kuaihuoyun.com/vehicle/update?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```

- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```


## 批量创建收款人接口

**简要描述：** 批量创建收款人

**请求 URL：** `/payee/batch_create`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 3次/秒

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**payees**  <br>*必填*|收款人列表，单次最多50个  <br>**长度** : `1 - 50`|< [收款人](#收款人) > array|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "payees": [
    {
      "bankCardNumber": "99030650508000212005",
      "bankName": "浙江网商银行",
      "idCard": "422432199210022595",
      "name": "马良",
      "note": "",
      "organizationName": "总部",
      "phoneNumber": "15527162085"
    }
  ]
}'
https://openapi.wlhy.pre.kuaihuoyun.com/payee/batch_create?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```
- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```

## 修改收款人信息接口

**简要描述：** 修改收款人信息，根据唯一标识更新对应收款人的信息

**请求 URL：** `/payee/update`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 3次/秒

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**bankCardNumber**  <br>*必填*|银行卡号，该字段为收款人的唯一标识|string|
|**bankName**  <br>*可选*|开户银行，支持的银行请参考[《部网络货运信息交互系统代码集》](https://fanyun-wlhy.oss-cn-hangzhou.aliyuncs.com/resources/部网络货运信息交互系统代码集.pdf)|string|
|**phoneNumber**  <br>*可选*|手机号，不填则置空  <br>**长度** : `11`|string|
|**note**  <br>*可选*|备注，不填则置空  <br>**长度** : `1 - 200`|string|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
    "bankCardNumber": "99030650508000212005",
    "bankName": "浙江网商银行",
    "idCard": "422432199210022595",
    "name": "马良",
    "note": "",
    "organizationName": "总部",
    "phoneNumber": "15527162085"
}'
https://openapi.wlhy.pre.kuaihuoyun.com/payee/update?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```

- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```

## 创建经纪人接口

**简要描述：** 创建经纪人接口，根据唯一标识创建对应的经纪人

**请求 URL：** `/open_middleman/create`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 3次/秒

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**middleman**  <br>*必填*|经纪人信息|[经纪人](#经纪人) Object|
|**organizationName**  <br>*可选*|组织机构名称，会创建至对应组织机构下，默认创建到总部|string|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "middleman": {
    "idCard": "110101198603073270",
    "idCardAddress": "浙江省杭州市西湖区xxxx",
    "idCardFrontUrl": "https://oss.56fanyun.com/ttms/0192b934087e4e3c9c00a6533e98be24.jpg",
    "idCardReverseUrl": "https://oss.56fanyun.com/ttms/ae7cace46e074456864f7959b418955b.jpg",
    "name": "李四三",
    "phoneNumber": "18058718162",
    "remark": ""
  },
  "organizationName": "总部"
}'
https://openapi.wlhy.pre.kuaihuoyun.com/payee/batch_create?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

注意事项
1. 经纪人姓名和身份证号必须真实一致

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```

- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```


# 财务类接口

## 核销接口(全部核销)

**简要描述：** 全部核销,不支持多笔核销

**请求 URL：** `/writeoff/writeoff`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 120次/分钟

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**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)|
|**payee**  <br>*运单有关联收款人时可选*|收款人，默认用运单司机关联的收款人，如果受理单没有关联收款人，这里必填|[收款人](#收款人)|
|**tradeNo**  <br>*必填*|资金流水号  <br>**长度** : `1 - 50`|string|
|**note**  <br>*可选*|付款备注  <br>**长度** : `0 - 256`|string|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "carNumber": "浙FY0000",
  "customerOrderNumbers": [
    "S2011181700651710"
  ],
  "driverName": "冯大大",
  "driverPhone": "13064797352",
  "note": "",
  "payFreight": 11.96,
  "payType": 5,
  "payee": {
    "bankCardNumber": "9059215995469884",
    "bankName": "兴业银行",
    "idCard": "110101199003078873",
    "name": "诸葛亮",
    "note": "",
    "organizationName": "总部",
    "phoneNumber": "13855552212"
  },
  "tradeNo": "232323"
}'
https://openapi.wlhy.pre.kuaihuoyun.com/writeoff/writeoff?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```
- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```


## 撤销核销接口

**简要描述：** 撤销核销

**请求 URL：** `/writeoff/cancel`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 120次/分钟

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**customerOrderNumbers**  <br>*必填*|结算受理单列表  <br>**样例** : `[ "XXX", "XXX" ]`|< string > array|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "customerOrderNumbers": [
    "S2011181700651710"
  ]
}'
https://openapi.wlhy.pre.kuaihuoyun.com/writeoff/cancel?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```
- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```

## 创建司机费用结算单接口

**简要描述：** 创建司机费用结算单

**请求 URL：** `/finance_driver_fee/save_settlement`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 180次/分钟

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**customerOrderNumbers**  <br>*必填*|结算受理单列表  <br>**样例** : `[ "XXX", "XXX" ]`|< string > array|
|**name**  <br>*必填*|司机姓名|string|
|**phone**  <br>*必填*|司机电话|string|
|**organizationName**  <br>*必填*|经办机构名称|string|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "customerOrderNumbers": [
    "S2011181700651710"
  ],
  "name": "冯大大",
  "phone": "13064797352",
  "organizationName": "总部"
}'
https://openapi.wlhy.pre.kuaihuoyun.com/finance_driver_fee/save_settlement?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```
- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```

## 查询司机费用结算单信息接口

**简要描述：** 查询司机费用结算单信息

**请求 URL：** `/finance_driver_fee/get_driver_fee_settlement`

**请求方式：** GET

**需要AccessToken：** 是

**调用限制：** 180次/分钟

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**settlementNumber**  <br>*必填*|结算单单号|< string >|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "settlementNumber": "CJ2011101349979601"
}'
https://openapi.wlhy.pre.kuaihuoyun.com/finance_driver_fee/get_driver_fee_settlement?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
  "code": 200,
  "message": null,
  "data": {
    "id": "5f910056095c37000a9f864e",
    "uid": "5e23cbe0e4b0e777fc3d57dc",         //承运商uid
    "operator": "5e23cbe0e4b0e777fc3d57dc",    //操作人
    "operatorName": "梵梵好运",                 //操作人名称
    "number": "CJ2010221145295153",            //结算单单号
    "driverId": "5f0e72c40305b5000ad596aa",    //司机ID
    "driverIdCard": "330327199407070419",      //司机身份证号
    "driverName": "陈林",                      //司机姓名
    "driverPhone": "18268320510",              //司机电话
    "carId": "5f894316708947000c777c39",       //车辆ID
    "carNumber": "浙A666666",                  //车辆牌照号
    "plateColorCode": "1",                     //车辆颜色
    "paidMeans": 0,
    "payee": {
      "id": "5f57291bc649a1000ab627cc",
      "accountType": 0,
      "name": "诸葛亮",                         //收款人姓名
      "bankCode": "FJIB",                      //银行
      "bankName": "兴业银行",                   //银行中文
      "bankCardNumber": "9059215995469884",    //银行卡号
      "phoneNumber": "",                       //电话
      "idCard": "110101199003078873",          //收款人身份证号
      "accountNo": null
    },
    "driverPayee": null,
    "customerOrderNumbers": [                  //受理单单号列表
      "S2010211416988492",
      "S2010211420973225"
    ],
    "state": 1,                                //结算单状态，0: 未核销; 1: 已核销; 2: 部分核销
    "totalFreight": 88,                        //应付金额
    "paidFreight": 88,                         //已付金额
    "unPaidFreight": 0,                        //未付金额
    "totalOrders": 2,                          //订单数
    "organizationPath": "0",                   //所属组织路径
    "orderOrganizationPath": "0",              //订单开单机构
    "note": null,                              //备注
    "writeOffNumbers": [                       //核销单号列表
      "CH2010221146820196"
    ],
    "writeOffResults": [                       //核销记录
      {
        "id": "5f91008a095c37000a9f8651",
        "number": "CH2010221146820196",        //核销单号
        "payType": 5,                          //支付类型，1油卡 5银行转账
        "freight": 88,                         //核销金额
        "totalOrders": 2                       //车次数
      }
    ],
    "writeOffNumber": "CH2010221146820196",
    "onlinePayState": 0,
    "paidTime": null,
    "businessMode": 0,
    "created": 1603338326,
    "updated": 1603338378
  }
}
```
- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```

## 分笔核销司机费用结算单接口

**简要描述：** 分笔核销司机费用结算单

**请求 URL：** `/finance_driver_fee/write_off`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 180次/分钟

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**settlementNumber**  <br>*必填*|结算单号|string|
|**payFreight**  <br>*必填*|支付金额|number(double)|
|**packCount**  <br>*必填*|车次数|number|
|**payType**  <br>*必填*|支付方式: 1油卡、5银行卡打款|number|
|**tradeNo**  <br>*可选*|资金流水号, 油卡支付时不用传|string|
|**note**  <br>*必填*|备注|string|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "settlementNumber": "",
  "payFreight": 100.01,
  "packCount": 1,
  "payType": 5,
  "tradeNo": "2323232323",
  "note": ""
}'
https://openapi.wlhy.pre.kuaihuoyun.com/finance_driver_fee/write_off?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**


- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```
- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```

# 财务类接口(撮合)

## 创建司机费用结算单接口(撮合)

**简要描述：** 创建司机费用结算单(撮合)

**请求 URL：** `/finance_driver_fee_match_up/save_settlement`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 180次/分钟

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**customerOrderNumbers**  <br>*必填*|结算受理单列表  <br>**样例** : `[ "XXX", "XXX" ]`|< string > array|
|**name**  <br>*必填*|司机姓名|string|
|**phone**  <br>*必填*|司机电话|string|
|**organizationName**  <br>*必填*|经办机构名称|string|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "customerOrderNumbers": [
    "S2011181700651710"
  ],
  "name": "冯大大",
  "phone": "13064797352",
  "organizationName": "总部"
}'
https://openapi.wlhy.pre.kuaihuoyun.com/finance_driver_fee_match_up/save_settlement?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```
- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```

## 查询司机费用结算单信息接口(撮合)

**简要描述：** 查询司机费用结算单信息(撮合)

**请求 URL：** `/finance_driver_fee_match_up/get_driver_fee_settlement`

**请求方式：** GET

**需要AccessToken：** 是

**调用限制：** 180次/分钟

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**settlementNumber**  <br>*必填*|结算单单号|< string >|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "settlementNumber": "CJ2011101349979601"
}'
https://openapi.wlhy.pre.kuaihuoyun.com/finance_driver_fee_match_up/get_driver_fee_settlement?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
  "code": 200,
  "message": null,
  "data": {
    "id": "5f910056095c37000a9f864e",
    "uid": "5e23cbe0e4b0e777fc3d57dc",         //承运商uid
    "operator": "5e23cbe0e4b0e777fc3d57dc",    //操作人
    "operatorName": "梵梵好运",                 //操作人名称
    "number": "CJ2010221145295153",            //结算单单号
    "driverId": "5f0e72c40305b5000ad596aa",    //司机ID
    "driverIdCard": "330327199407070419",      //司机身份证号
    "driverName": "陈林",                      //司机姓名
    "driverPhone": "18268320510",              //司机电话
    "carId": "5f894316708947000c777c39",       //车辆ID
    "carNumber": "浙A666666",                  //车辆牌照号
    "plateColorCode": "1",                     //车辆颜色
    "paidMeans": 0,
    "payee": {
      "id": "5f57291bc649a1000ab627cc",
      "accountType": 0,
      "name": "诸葛亮",                         //收款人姓名
      "bankCode": "FJIB",                      //银行
      "bankName": "兴业银行",                   //银行中文
      "bankCardNumber": "9059215995469884",    //银行卡号
      "phoneNumber": "",                       //电话
      "idCard": "110101199003078873",          //收款人身份证号
      "accountNo": null
    },
    "driverPayee": null,
    "customerOrderNumbers": [                  //受理单单号列表
      "S2010211416988492",
      "S2010211420973225"
    ],
    "state": 1,                                //结算单状态，0: 未核销; 1: 已核销; 2: 部分核销
    "totalFreight": 88,                        //应付金额
    "paidFreight": 88,                         //已付金额
    "unPaidFreight": 0,                        //未付金额
    "totalOrders": 2,                          //订单数
    "organizationPath": "0",                   //所属组织路径
    "orderOrganizationPath": "0",              //订单开单机构
    "note": null,                              //备注
    "writeOffNumbers": [                       //核销单号列表
      "CH2010221146820196"
    ],
    "writeOffResults": [                       //核销记录
      {
        "id": "5f91008a095c37000a9f8651",
        "number": "CH2010221146820196",        //核销单号
        "payType": 5,                          //支付类型，1油卡 5银行转账
        "freight": 88,                         //核销金额
        "totalOrders": 2                       //车次数
      }
    ],
    "writeOffNumber": "CH2010221146820196",
    "onlinePayState": 0,
    "paidTime": null,
    "businessMode": 0,
    "created": 1603338326,
    "updated": 1603338378
  }
}
```
- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```

## 分笔核销司机费用结算单接口(撮合)

**简要描述：** 分笔核销司机费用结算单(撮合)

**请求 URL：** `/finance_driver_fee_match_up/write_off`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 180次/分钟

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**settlementNumber**  <br>*必填*|结算单号|string|
|**payFreight**  <br>*必填*|支付金额|number(double)|
|**packCount**  <br>*必填*|车次数|number|
|**payType**  <br>*必填*|支付方式: 1油卡、5银行卡打款|number|
|**tradeNo**  <br>*可选*|资金流水号, 油卡支付时不用传|string|
|**note**  <br>*必填*|备注|string|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "settlementNumber": "",
  "payFreight": 100.01,
  "packCount": 1,
  "payType": 5,
  "tradeNo": "2323232323",
  "note": ""
}'
https://openapi.wlhy.pre.kuaihuoyun.com/finance_driver_fee_match_up/write_off?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**


- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```
- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```

# 合同类接口

## 创建承运人合同接口

**简要描述：** 创建承运人合同

**请求 URL：** `/contract/driver/create`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 3次/秒

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**number**  <br>*必填*|合同编号|string|
|**name**  <br>*必填*|承运人姓名|string|
|**phone**  <br>*必填*|承运人电话|string|
|**certNo**  <br>*必填*|承运人身份证号|string|
|**contractDate**  <br>*必填*|签约日期，格式`yyyy-MM-dd` <br>**样例** : `2020-01-01`|string|
|**startDate**  <br>*必填*|合同开始日期，格式`yyyy-MM-dd` <br>**样例** : `2020-01-01`|string|
|**endDate**  <br>*必填*|合同截止日期，格式`yyyy-MM-dd` <br>**样例** : `2020-01-01`|string|
|**fileUrl**  <br>*必填*|合同文件地址 <br>**样例** : `https://www.a.com/z.pdf`|string|
|**organizationName**  <br>*可选*|组织机构名称，会创建至对应组织机构下，默认创建到总部|string|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "certNo": "110101196603072412",
  "contractDate": "2020-01-01",
  "endDate": "2022-01-01",
  "fileUrl": "https://www.a.com/z.pdf",
  "name": "冯大大",
  "number": "HT00001",
  "organizationName": "总部",
  "phone": "13064797352",
  "startDate": "2020-01-02"
}'
https://openapi.wlhy.pre.kuaihuoyun.com/contract/driver/create?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```

- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```

## 创建委托代收合同接口

**简要描述：** 创建委托代收合同

**请求 URL：** `/contract/middleman/create`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 3次/秒

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**number**  <br>*必填*|合同编号|string|
|**name**  <br>*必填*|司机姓名|string|
|**phone**  <br>*必填*|司机电话|string|
|**certNo**  <br>*必填*|司机身份证号|string|
|**name2**  <br>*必填*|经纪人姓名|string|
|**phone2**  <br>*必填*|经纪人电话|string|
|**certNo2**  <br>*必填*|经纪人身份证号|string|
|**contractDate**  <br>*可选*|签约日期，格式`yyyy-MM-dd` <br>**样例** : `2020-01-01`|string|
|**startDate**  <br>*必填*|合同开始日期，格式`yyyy-MM-dd` <br>**样例** : `2020-01-01`|string|
|**endDate**  <br>*必填*|合同截止日期，格式`yyyy-MM-dd` <br>**样例** : `2020-01-01`|string|
|**fileUrl**  <br>*必填*|合同文件地址 <br>**样例** : `https://www.a.com/z.pdf`|string|
|**organizationName**  <br>*可选*|组织机构名称，会创建至对应组织机构下，默认创建到总部|string|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "name": "冯大大",
  "phone": "13064797352",
  "certNo": "110101196603072412",
  "name2": "冯测",
  "phone2": "13064797353",
  "certNo2": "110101196603072416",
  "contractDate": "2020-01-01",
  "endDate": "2022-01-01",
  "fileUrl": "https://www.a.com/z.pdf",
  "number": "HT00001",
  "organizationName": "总部",
  "startDate": "2020-01-02"
}'
https://openapi.wlhy.pre.kuaihuoyun.com/contract/middleman/create?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```

- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```

## 创建撮合单票承运人合同接口

**简要描述：** 创建撮合单票承运人合同

**请求 URL：** `/matchup/contract/driver/create`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 3次/秒

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**orderNumber**  <br>*必填*|运单编号|string|
|**number**  <br>*必填*|合同编号|string|
|**name**  <br>*必填*|承运人姓名|string|
|**phone**  <br>*必填*|承运人电话|string|
|**certNo**  <br>*必填*|承运人身份证号|string|
|**contractDate**  <br>*必填*|签约日期，格式`yyyy-MM-dd` <br>**样例** : `2020-01-01`|string|
|**fileUrl**  <br>*必填*|合同文件地址 <br>**样例** : `https://www.a.com/z.pdf`|string|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "orderNumber": "S2011181700651710",
  "number": "HT00001",
  "name": "冯测",
  "phone": "13064797352",
  "certNo": "110101196603072412",
  "contractDate": "2020-01-01",
  "fileUrl": "https://www.a.com/z.pdf"
}'
https://openapi.wlhy.pre.kuaihuoyun.com/matchup/contract/driver/create?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```

- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```


# 实名认证类接口

## 实名认证接口

**简要描述：** 使用自有业务系统APP的场景需要接入实名认证和嵌入网络货运SDK

**请求 URL：** `/ocr/face_match`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 100次/天

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**name**  <br>*必填*|姓名 |string|
|**certNo**  <br>*必填*|身份证号|string|
|**certImg**  <br>*必填*|身份证图片，图片数据大小不超过3M，仅支持jpg、png格式<br>**格式** : `Base64`|string|
|**headImg**  <br>*必填*|人脸图片，图片数据大小不超过3M，仅支持jpg、png格式<br>**格式** : `Base64`|string|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "name": "冯大大",
  "certNo": "110101196603072412",
  "certImg": "base64",
  "headImg": "base64"
}'
https://openapi.wlhy.pre.kuaihuoyun.com/ocr/face_match?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```
- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```


# 位置信息类接口

## 上报运单轨迹接口

**简要描述：** 上报运单轨迹接口，位置信息必须是在上报运单的运输时间范围内的，否则会被拒绝。上报后如果无法看到轨迹，先确认运单绑定的设备是否在智能管车中绑定了小黑卡，若已绑定小黑卡则将使用小黑卡的轨迹数据。

**请求 URL：** `/gps/report_gps_data_for_order`

**请求方式：** POST

**需要AccessToken：** 是

**调用限制：** 120次/分钟

**请求参数：**

|名称|说明|类型|
|---|---|---|
|**orderNumber**  <br>*必填*|运单号|string|
|**gpsDataList**  <br>*必填*|位置信息列表，如果定位点较多，超过了单次请求的数量限制，则多次调用，分批上报  <br>**长度** : `1 - 500`|< [位置信息](#位置信息) > array|

**请求示例**

```shell script
curl -H "Content-Type:application/json" -X POST --data
'{
  "orderNumber": "S2011181700651710",
  "gpsDataList": [
    {
      "longitude": 116.405289,
      "latitude": 39.904987,
      "locateTime": 1604970800,
      "locateType": 1,
      "runStatus": 1
    }
    ……
  ]
}'
https://openapi.wlhy.pre.kuaihuoyun.com/gps/report_gps_data_for_order?access_token=c585f98d-7063-45f0-a83e-081387cd6c0c
```

**返回示例**

- 调用成功示例

```java
{
    "code": 200,
    "data": true,
    "message": null
}
```

- 调用失败示例

```java
{
    "code": 500,
    "message": "xxxxxxxx"
}
```

# 接口参数说明

## 运单

|名称|说明|类型|
|---|---|---|
|**orderNumber**  <br>*更新运单时必填*|运单号，更新运单时必填，创建运单时不需要填写|string|
|**originalOrderNumber**  <br>*必填*|客户单号  <br>**长度** : `1 - 50`|string|
|**businessType**  <br>*必填*|业务类型  <br>**可选值** : `干线普货运输, 城市配送, 农村配送, 集装箱运输, 其他`|string|
|**consignerName**  <br>*必填*|发货人姓名  <br>**长度** : `1 - 45`|string|
|**consignerPhone**  <br>*必填*|发货人电话  <br>**长度** : `1 - 20`|string|
|**consignerAddress**  <br>*必填*|发货人地址|[地址](#地址)|
|**consignerIdCard**  <br>*必填*|发货人证件号  <br>**长度** : `1 - 35`|string|
|**consigneeName**  <br>*必填*|收货人姓名  <br>**长度** : `1 - 45`|string|
|**consigneePhone**  <br>*必填*|收货人电话  <br>**长度** : `1 - 20`|string|
|**freightIn**  <br>*必填*|运单运费信息|[运单运费](#运单运费)|
|**consigneeAddress**  <br>*必填*|收货人地址|[地址](#地址)|
|**cargoList**  <br>*必填*|货物列表|< [货物](#货物) > array|
|**carrier**  <br>*可选*|承运人|[承运人](#承运人)|
|**payee**  <br>*可选*|收款人|[收款人](#受理单收款人)|
|**consigneeIdCard**  <br>*可选*|收货人证件号  <br>**长度** : `0 - 35`|string|
|**appointArriveTime**  <br>*可选*|预约送达时间。时间戳|integer (int32)|
|**openTime**  <br>*可选*|开单时间。时间戳|integer (int32)|
|**deliveryTime**  <br>*可选*|提货时间。时间戳|integer (int32)|
|**deliveryType**  <br>*可选*|提送类型。1：自提；2：送货|integer (int32)|
|**endAddress**  <br>*可选*|目的地  <br>**长度** : `0 - 20`|string|
|**note1**  <br>*可选*|自定义备注1|string|
|**note2**  <br>*可选*|自定义备注2|string|
|**note3**  <br>*可选*|自定义备注3|string|
|**note4**  <br>*可选*|自定义备注4|string|
|**note5**  <br>*可选*|自定义备注5|string|
|**note6**  <br>*可选*|自定义备注6|string|
|**note7**  <br>*可选*|自定义备注7|string|
|**note8**  <br>*可选*|自定义备注8|string|
|**note9**  <br>*可选*|自定义备注9|string|
|**note10**  <br>*可选*|自定义备注10|string|
|**note11**  <br>*可选*|自定义备注11|string|
|**note12**  <br>*可选*|自定义备注12|string|
|**paymentCollect**  <br>*可选*|代收货款  <br>**最小值** : `0`  <br>**最大值** : `999999`|number (double)|
|**receiptCount**  <br>*可选*|回单数  <br>**最小值** : `0`  <br>**最大值** : `999`|integer (int32)|
|**remarks**  <br>*可选*|备注  <br>**长度** : `1 - 250`|string|
|**salesman**  <br>*可选*|业务员  <br>**长度** : `0 - 20`|string|
|**salesmanPhone**  <br>*可选*|业务员电话  <br>**长度** : `0 - 12`|string|
|**settlementName**  <br>*可选*|结算方名称  <br>**长度** : `0 - 50`|string|
|**settlementPhone**  <br>*可选*|结算方电话  <br>**长度** : `0 - 20`|string|
|**shipperPay**  <br>*可选*|上游运费  <br>**最小值** : `0`  <br>**最大值** : `9999999`|number (double)|
|**shipperPayType**  <br>*可选*|上游运费支付方式  <br>**可选值** : 1：现付；2：到付；3：回付；4：周结；5：月结；6：货款扣；7：季度结；8：在线支付；9：到付月结|integer (int32)|
|**startAddress**  <br>*可选*|起始地  <br>**长度** : `0 - 20`|string|
|**project**  <br>*可选*|项目|string|

## 撮合运单
|名称|说明|类型|
|---|---|---|
|**originalOrderNumber**  <br>*必填*|客户单号  <br>**长度** : `1 - 50`|string|
|**businessType**  <br>*必填*|业务类型  <br>**可选值** : `干线普货运输, 城市配送, 农村配送, 集装箱运输, 其他`|string|
|**consignerName**  <br>*必填*|发货人姓名  <br>**长度** : `1 - 45`|string|
|**consignerPhone**  <br>*必填*|发货人电话  <br>**长度** : `1 - 20`|string|
|**consignerAddress**  <br>*必填*|发货人地址|[地址](#地址)|
|**consignerIdCard**  <br>*必填*|发货人证件号  <br>**长度** : `1 - 35`|string|
|**consigneeName**  <br>*必填*|收货人姓名  <br>**长度** : `1 - 45`|string|
|**consigneePhone**  <br>*必填*|收货人电话  <br>**长度** : `1 - 20`|string|
|**consigneeAddress**  <br>*必填*|收货人地址|[地址](#地址)|
|**consigneeIdCard**  <br>*可选*|收货人证件号  <br>**长度** : `0 - 35`|string|
|**cargoList**  <br>*必填*|货物列表|< [货物](#货物) > array|
|**carrier**  <br>*可选*|承运人|[承运人](#承运人)|
|**payee**  <br>*可选*|收款人|[收款人](#受理单收款人)|
|**appointArriveTime**  <br>*可选*|预约送达时间。时间戳|integer (int32)|
|**openTime**  <br>*可选*|开单时间。时间戳|integer (int32)|
|**deliveryTime**  <br>*可选*|提货时间。时间戳|integer (int32)|
|**deliveryType**  <br>*可选*|提送类型。1：自提；2：送货|integer (int32)|
|**endAddress**  <br>*可选*|目的地  <br>**长度** : `0 - 20`|string|
|**note1**  <br>*可选*|自定义备注1|string|
|**note2**  <br>*可选*|自定义备注2|string|
|**note3**  <br>*可选*|自定义备注3|string|
|**note4**  <br>*可选*|自定义备注4|string|
|**note5**  <br>*可选*|自定义备注5|string|
|**note6**  <br>*可选*|自定义备注6|string|
|**note7**  <br>*可选*|自定义备注7|string|
|**note8**  <br>*可选*|自定义备注8|string|
|**note9**  <br>*可选*|自定义备注9|string|
|**note10**  <br>*可选*|自定义备注10|string|
|**note11**  <br>*可选*|自定义备注11|string|
|**note12**  <br>*可选*|自定义备注12|string|
|**paymentCollect**  <br>*可选*|代收货款  <br>**最小值** : `0`  <br>**最大值** : `999999`|number (double)|
|**receiptCount**  <br>*可选*|回单数  <br>**最小值** : `0`  <br>**最大值** : `999`|integer (int32)|
|**remarks**  <br>*可选*|备注  <br>**长度** : `1 - 250`|string|
|**salesman**  <br>*可选*|业务员  <br>**长度** : `0 - 20`|string|
|**salesmanPhone**  <br>*可选*|业务员电话  <br>**长度** : `0 - 12`|string|
|**startAddress**  <br>*可选*|起始地  <br>**长度** : `0 - 20`|string|
|**project**  <br>*可选*|项目|string|

## 货物

|名称|说明|类型|
|---|---|---|
|**name**  <br>*必填*|货物名称  <br>**长度** : `1 - 150`|string|
|**type**  <br>*必填*|货物类型名称|可选值请参考[《部网络货运信息交互系统代码集》](https://fanyun-wlhy.oss-cn-hangzhou.aliyuncs.com/resources/部网络货运信息交互系统代码集.pdf)|
|**weight**  <br>*必填*|重量(千克)  <br>**最小值** : `0`  <br>**最大值** : `99999999`|number (double)|
|**quantity**  <br>*可选*|件数  <br>**最小值** : `0`  <br>**最大值** : `999999`|number (double)|
|**value**  <br>*可选*|货值  <br>**最小值** : `0`  <br>**最大值** : `9999999`|number (double)|
|**volume**  <br>*可选*|体积  <br>**最小值** : `0`  <br>**最大值** : `9999`|number (double)|
|**unloadWeight**  <br>*可选*|卸货重量(千克)  <br>**最小值** : `0`  <br>**最大值** : `99999999`|number (double)|
|**unloadQuantity**  <br>*可选*|卸货件数  <br>**最小值** : `0`  <br>**最大值** : `999999`|number (double)|
|**unloadVolume**  <br>*可选*|卸货体积  <br>**最小值** : `0`  <br>**最大值** : `9999`|number (double)|
|**productModel**  <br>*可选*|货物备注  <br>**长度** : `0 - 100`|string|
|**note1**  <br>*可选*|自定义备注1|string|
|**note2**  <br>*可选*|自定义备注2|string|
|**note3**  <br>*可选*|自定义备注3|string|
|**note4**  <br>*可选*|自定义备注4|string|
|**note5**  <br>*可选*|自定义备注5|string|
|**note6**  <br>*可选*|自定义备注6|string|

## 承运人

|名称|说明|类型|
|---|---|---|
|**carNumber**  <br>*必填*|车牌号码，车牌号码、司机电话、司机姓名需同时填写或同时不填写  <br>**长度** : `1 - 20`|string|
|**driverName**  <br>*必填*|司机名称，车牌号码、司机电话、司机姓名需同时填写或同时不填写  <br>**长度** : `1 - 20`|string|
|**driverPhone**  <br>*必填*|司机电话，车牌号码、司机电话、司机姓名需同时填写或同时不填写  <br>**长度** : `1 - 20`|string|
|**driverFreight**  <br>*必填*|司机运费  <br>**最小值** : `0`  <br>**最大值** : `999999`|number (double)|
|**carrierName**  <br>*可选*|承运人姓名，承运人姓名和承运人电话需同时填写或同时不填写，不填写承运人信息时使用司机作为承运人  <br>**长度** : `1 - 20`|string|
|**carrierPhone**  <br>*可选*|承运人电话，承运人姓名和承运人电话需同时填写或同时不填写，不填写承运人信息时使用司机作为承运人  <br>**长度** : `1 - 20`|string|
|**insuranceCompany**  <br>*可选*|保险公司名称  <br>**长度** : `0 - 30`|string|
|**insuranceNumber**  <br>*可选*|保险单号  <br>**长度** : `0 - 30`|string|

## 受理单收款人

|名称|说明|类型|
|---|---|---|
|**name**  <br>*必填*|银行开户名  <br>**长度** : `1 - 20`|string|
|**bankCardNumber**  <br>*必填*|银行卡号 |string|
|**bankName**  <br>*必填*|开户银行，支持的银行请参考[《部网络货运信息交互系统代码集》](https://fanyun-wlhy.oss-cn-hangzhou.aliyuncs.com/resources/部网络货运信息交互系统代码集.pdf)|string|
|**idCard**  <br>*必填*|身份证  <br>**长度** : `18`|string|
|**phoneNumber**  <br>*可选*|手机号  <br>**长度** : `11`|string|

## 地址

省市区可选值参考：http://go.56ctms.com/s/BuxJEn09

|名称|说明|类型|
|---|---|---|
|**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)|

## 运单运费

|名称|说明|类型|
|---|---|---|
|**amount**  <br>*必填*|运费金额，如无运费，填0即可|number (double)|
|**payType**  <br>*可选*|支付方式，1：现付， 2：到付， 3：回付， 4：周结， 5：月结， 6：货款扣， 7：季度结， 8：在线支付， 9：到付月结 |integer (int32)|

## 司机

|名称|说明|类型|
|---|---|---|
|**idCard**  <br>*必填*|身份证，该字段为司机的唯一标识|string|
|**name**  <br>*必填*|姓名  <br>**长度** : `1 - 20`|string|
|**phoneNumber**  <br>*必填*|手机号  <br>**长度** : `11`|string|
|**idCardAddress**  <br>*必填*|身份证地址  <br>**长度** : `1 - 80`|string|
|**driverLicenseIssuingAuthority**  <br>*必填*|驾驶证发证机关  <br>**长度** : `1 - 50`|string|
|**driverLicenseNumber**  <br>*必填*|驾驶证编号  <br>**长度** : `1 - 18`|string|
|**driverLicenseEndTime**  <br>*必填*|驾驶证有效期结束时间，时间戳，精确到秒|integer (int64)|
|**driverLicenseStartTime**  <br>*必填*|驾驶证有效期开始时间，时间戳，精确到秒，如果为长期，请填写`-1`|integer (int64)|
|**qualificationCertificateNumber**  <br>*必填*|从业资格证号  <br>**长度** : `1 - 19`|string|
|**quasiDrivingModel**  <br>*必填*|准驾车型, 可选车型["A1", "A2", "A3", "B1", "B2", "C1", "D", "E"], 多个准驾车型以逗号隔开, 例："A1,A2"  <br>**长度** : `1 - 20`|string|
|**idCardStartTime**  <br>*可选*|身份证生效日期，时间戳，精确到秒|integer (int64)|
|**idCardEndTime**  <br>*可选*|身份证失效日期，时间戳，精确到秒，如果为长期，请填写`-1`|integer (int64)|
|**organizationName**  <br>*可选*|组织机构名称，会创建至对应组织机构下，默认创建到总部|string|
|**idCardBackUrl**  <br>*可选*|身份证背面图片地址|string|
|**idCardFrontUrl**  <br>*可选*|身份证正面图片地址|string|
|**driverLicenseUrl**  <br>*可选*|驾驶证图片地址|string|
|**qualificationCertificateUrlList**  <br>*可选*|从业资格证图片地址，最多传输4张|< string > array|
|**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>*与`licensePlateColorCode`二选一必填*|车牌颜色，和车牌颜色代码对应，两个中必填一个，优先使用本字段的值，代码集请参考[《部网络货运信息交互系统代码集》](https://fanyun-wlhy.oss-cn-hangzhou.aliyuncs.com/resources/部网络货运信息交互系统代码集.pdf)|string|
|**licensePlateColorCode**  <br>*与`licensePlateColor`二选一必填*|车牌颜色代码，和车牌颜色对应|string|
|**vehicleType**  <br>*与`vehicleTypeCode`二选一必填*|车辆类型，和车辆类型代码对应，两个中必填一个，优先使用本字段的值，代码集请参考[《部网络货运信息交互系统代码集》](https://fanyun-wlhy.oss-cn-hangzhou.aliyuncs.com/resources/部网络货运信息交互系统代码集.pdf)|string|
|**vehicleTypeCode**  <br>*与`vehicleType`二选一必填*|车辆类型代码，和车辆类型对应|string|
|**vehicleEnergyType**  <br>*与`vehicleEnergyTypeCode`二选一必填*|车辆能源类型，和车辆能源类型代码对应，两个中必填一个，优先使用本字段的值，代码集请参考[《部网络货运信息交互系统代码集》](https://fanyun-wlhy.oss-cn-hangzhou.aliyuncs.com/resources/部网络货运信息交互系统代码集.pdf)|string|
|**vehicleEnergyTypeCode**  <br>*与`vehicleEnergyType`二选一必填*|车辆能源类型代码，和车辆能源类型对应|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|
|**organizationName**  <br>*可选*|组织机构名称，会创建至对应组织机构下，默认创建到总部|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|

## 收款人

|名称|说明|类型|
|---|---|---|
|**bankCardNumber**  <br>*必填*|银行卡号，该字段为收款人的唯一标识|string|
|**name**  <br>*必填*|银行开户名  <br>**长度** : `1 - 20`|string|
|**bankName**  <br>*必填*|开户银行，支持的银行请参考[《部网络货运信息交互系统代码集》](https://fanyun-wlhy.oss-cn-hangzhou.aliyuncs.com/resources/部网络货运信息交互系统代码集.pdf)|string|
|**idCard**  <br>*必填*|身份证|string|
|**organizationName**  <br>*可选*|组织机构名称，会创建至对应组织机构下，默认创建到总部|string|
|**phoneNumber**  <br>*可选*|手机号  <br>**长度** : `11`|string|
|**note**  <br>*可选*|备注  <br>**长度** : `1 - 200`|string|

## 经纪人
|名称|说明|类型|
|---|---|---|
|**idCardFrontUrl**  <br>*必填*|身份证正面图片地址|string|
|**idCardReverseUrl**  <br>*必填*|身份证反面图片地址|string|
|**name**  <br>*必填*|姓名|string|
|**phoneNumber**  <br>*必填*|手机号|string|
|**idCard**  <br>*必填*|身份证号|string|
|**idCardAddress**  <br>*可选*|身份证地址|string|
|**remark**  <br>*可选*|备注  <br>**长度** : `1 - 200`|string|

## 位置信息

|名称|说明|类型|
|---|---|---|
|**longitude**  <br>*必填*|经度|number (double)|
|**latitude**  <br>*必填*|纬度|number (double)|
|**locateTime**  <br>*必填*|定位时间（时间戳，精确到秒），定位时间必须在设备运输时间范围内（开单时间和签收时间之间，未签收时为开单时间到开单时间往后45天之间）|integer (int32)|
|**locateType**  <br>*必填*|定位类型：(0：未知，1：GPS，2：基站定位，4：北斗定位，5：GPS 和北斗定位）|integer (int32)|
|**runStatus**  <br>*必填*|设备运行状态（1:行驶，2:停止，3:离线）|integer (int32)|
|**addr**  <br>*可选*|设备完整定位地址，包含省市区  <br>**例** : `浙江省杭州市西湖区计量大厦`|string|
|**province**  <br>*可选*|定位省份|string|
|**city**  <br>*可选*|定位城市|string|
|**roadName**  <br>*可选*|定位街道|string|
|**speed**  <br>*可选*|设备速度（单位：km／h）|number (double)|
|**direction**  <br>*可选*|设备运动方向（单位：角度）|number (double)|
|**temperature**  <br>*可选*|设备温度（单位：度）|number (double)|
|**humidity**  <br>*可选*|设备湿度（单位：度）|number (double)|
|**powerRate**  <br>*可选*|设备电量（单位：%）|integer (int32)|