Home Explore Help
Register Sign In
gongmingwei
/
celestia-api-doc
2
1
Fork 1
Files Issues 0 Pull Requests 0 Wiki
Tree: 91e7b8284a
Branches Tags
celestia-api...
/
README.md

README.md 96 KB
History Raw

网络货运开放接口文档

接口简介：

本文档为网络货运开放接口文档，对接流程为：

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

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

相关说明(请仔细阅读!)：

  1. 什么是主账号：
    即贵公司在我们系统中创建的第一个账号，其后所有的贵公司系统中的账号都是子账号。如果不知道自己是否使用的主账号或者主账号具体是哪个请联系相关负责人。

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

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

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

  5. 调用接口方式：
    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. 调试接口：
    推荐使用Postman，或者访问接口URL，会跳转至调试界面

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

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

  9. 返回HTTP协议状态码：

状态码 说明
200 调用接口成功
401 授权失败，需要重新登陆获取access_token
404 接口不存在，请检查调用的接口地址，协议的格式是否正确
500 服务异常，具体错误原因会在返回结果中说明
  1. 返回字段(HTTP状态200)：
名称 说明
code 状态码
data 返回数据，接口调用成功（状态码为 200）之后返回的数据
message 错误信息，当接口调用失败（状态码为 非200）时，返回的错误信息，调用成功时返回null

返回示例

  • 调用成功示例
{
    "code": 200,
    "data": <object>,
    "message": null
}
  • 调用失败示例
{
    "code": 500,
    "message": "xxxxxxxx"
}

接口凭证

获取登陆凭证接口

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

请求 URL： /user/generate_access_token

请求方式： POST

需要AccessToken： 否

调用限制： 60次/分钟

请求参数：

名称 说明 类型
userName
必填		 账号 string
password
必填		 密码 string

请求参数示例

{
    "userName": "19012345678",
    "password": "111111"
}

返回示例

{
    "code": 200,
    "message": null,
    "data": {
        "accessToken": "9d0dfe02-2349-421c-90ec-4b9ea174701b",
        "refreshToken": "9f8326bc-c29f-4a28-a512-26caa1a9850a"
    }
}

获取登陆凭证接口（加密）

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

请求 URL： /user/generate_access_token/v2

请求方式： POST

需要AccessToken： 否

调用限制： 60次/分钟

请求参数：

名称 说明 类型
userName
必填		 账号 string
password
必填		 密码 string，md5加密

请求参数示例

{
    "userName": "19012345678",
    "password": "96e79218965eb72c92a549dd5a330112"
}

返回示例

{
    "code": 200,
    "message": null,
    "data": {
        "accessToken": "9d0dfe02-2349-421c-90ec-4b9ea174701b",
        "refreshToken": "9f8326bc-c29f-4a28-a512-26caa1a9850a"
    }
}

更新登陆凭证接口

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

请求 URL： /user/refresh_access_token

请求方式： POST

需要AccessToken： 否

调用限制： 60次/分钟

请求参数：

名称 说明 类型
userName
必填		 账号 string
refreshToken
必填		 刷新凭证 string

请求参数示例

{
    "userName": "19012345678",
    "refreshToken": "9f8326bc-c29f-4a28-a512-22caa1a3850a"
}

返回示例

{
    "code": 200,
    "message": null,
    "data": {
        "accessToken": "9d0dfe02-2349-421c-90ec-4b9ea174701b",
        "refreshToken": "9f8326bc-c29f-4a28-a512-26caa1a9850a"
    }
}

运单类接口

创建运单接口

简要描述： 开单，货物重量单位取系统内高级设置中设置的重量单位

请求 URL： /order/create_order

请求方式： POST

需要AccessToken： 是

调用限制： 3次/秒

请求参数：

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

请求参数示例

{
    "orders": [
        {
            "appointArriveTime": 1604973799,
            "businessType": "干线普货运输",
            "startAddress": "浙江省滨江区滨文路100号",
            "endAddress": "浙江省西湖区计量大楼",
            "paymentCollect": 100,
            "receiptCount": 1,
            "cargoList": [
                {
                    "name": "煤炭",
                    "note1": "",
                    "note2": "",
                    "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": "",
            "openTime": 1604970800,
            "originalOrderNumber": "KH10001",
            "payee": {
                "bankCardNumber": "6227002470170278192",
                "bankName": "建设银行",
                "idCard": "110101199003079673",
                "name": "林曦",
                "phoneNumber": "15899125566"
            },
            "remarks": "",
            "salesman": "韩风",
            "salesmanPhone": "15678102991",
            "settlementName": "",
            "settlementPhone": "",
            "project": "",
            "loadImages": [
              "https://oss.xxxx.com/xxxxx.png", 
              "https://oss.xxxx.com/xxxxx.png"
            ],
            "unloadImages": [
              "https://oss.xxxx.com/xxxxx.png", 
              "https://oss.xxxx.com/xxxxx.png"
            ]
        }
    ],
    "organizationName": "总部"
}

返回示例

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

更新运单接口

简要描述： 更新运单，注意事项

  1. 修改货物时重量单位默认为千克，可以通过weightUnit字段指定单位
  2. 更新为覆盖更新，所以原字段值也需要传递
  3. 装卸货图片为覆盖更新，并不是新增到已有的图片中，如：原本传了5张，更新时只传了1张，则最终会变成1张图片

请求 URL： /order/update_order

请求方式： POST

需要AccessToken： 是

调用限制： 3次/秒

请求参数：

请参考：运单

请求参数示例

{
    "orderNumber": "S2010291432590922",
    "appointArriveTime": 1604973799,
    "businessType": "干线普货运输",
    "startAddress": "浙江省滨江区滨文路100号",
    "endAddress": "浙江省西湖区计量大楼",
    "paymentCollect": 100,
    "receiptCount": 1,
    "cargoList": [
        {
            "name": "煤炭",
            "note1": "",
            "note2": "",
            "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,
    "lng": 120.065772, 
        "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": "",
    "openTime": 1604970800,
    "originalOrderNumber": "KH10001",
    "payee": {
        "bankCardNumber": "6227002470170278192",
        "bankName": "建设银行",
        "idCard": "110101199003079673",
        "name": "林曦",
        "phoneNumber": "15899125566"
    },
    "remarks": "",
    "salesman": "韩风",
    "salesmanPhone": "15678102991",
    "settlementName": "",
    "settlementPhone": "",
    "loadImages": [
      "https://oss.xxxx.com/xxxxx.png", 
      "https://oss.xxxx.com/xxxxx.png"
    ],
    "unloadImages": [
      "https://oss.xxxx.com/xxxxx.png", 
      "https://oss.xxxx.com/xxxxx.png"
    ]
}

返回示例

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

签收运单接口

简要描述： 签收运单

请求 URL： /order/signOff_order

请求方式： POST

需要AccessToken： 是

调用限制： 3次/秒

请求参数：

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

请求参数示例

{
    "orderNumbers": ["S2010291432590922"],
    "signer": "签收人",
    "signTime": 1604970800
}

返回示例

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

查询运单接口

简要描述： 查询运单

请求 URL： /order/query_order

请求方式： POST

需要AccessToken： 是

调用限制： 5次/秒

请求参数：

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

请求参数示例

{
    "page": 1,
    "size": 10,
    "orderNumbers": ["S2010291432590922", "S2010291432590923"]
}

返回示例

{
  "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": 1,                                 // 申诉状态
          "abnormalAppealStateDesc": "正常",                         // 申诉状态描述，正常、不可开票、可申诉、空字符串（没有风控结果）
          "rejectType": 1,                                          // 不可开票原因类型，1：风控审查不通过，2：异常申述审核不通过，3：手动操作不开票
          "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
  }
}

撤销运单接口

简要描述： 撤销运单

请求 URL： /order/cancel_order

请求方式： POST

需要AccessToken： 是

调用限制： 3次/秒

请求参数：

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

请求参数示例

{
  "orderNumbers": ["S2010291432590922"]
}

返回示例

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

创建撮合运单接口

简要描述： 撮合开单

请求 URL： /order_match_up/create_order_match_up

请求方式： POST

需要AccessToken： 是

调用限制： 3次/秒

请求参数：

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

请求参数示例

{
    "orderMatchUpList": [
        {
            "appointArriveTime": 1604973799,
            "businessType": "干线普货运输",
            "startAddress": "浙江省滨江区滨文路100号",
            "endAddress": "浙江省西湖区计量大楼",
            "paymentCollect": 100,
            "receiptCount": 1,
            "cargoList": [
                {
                    "name": "煤炭",
                    "note1": "",
                    "note2": "",
                    "note3": "",
                    "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": "",
            "openTime": 1604970800,
            "originalOrderNumber": "KH10001",
            "payee": {
                "bankCardNumber": "6227002470170278192",
                "bankName": "建设银行",
                "idCard": "110101199003079673",
                "name": "林曦",
                "phoneNumber": "15899125566"
            },
            "remarks": "",
            "salesman": "韩风",
            "salesmanPhone": "15678102991",
            "loadImages": [
              "https://oss.xxxx.com/xxxxx.png", 
              "https://oss.xxxx.com/xxxxx.png"
            ],
            "unloadImages": [
              "https://oss.xxxx.com/xxxxx.png", 
              "https://oss.xxxx.com/xxxxx.png"
            ]
        }
    ],
    "organizationName": "总部"
}

返回示例

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

基础信息类接口

司机相关接口

批量创建司机接口

简要描述： 批量创建司机，如果身份证已存在，则会更新司机信息。 注意事项

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

请求 URL： /driver/batch_create

请求方式： POST

需要AccessToken： 是

调用限制： 3次/秒

请求参数：

名称 说明 类型
drivers
必填		 司机列表，单次最多50个
长度 : 1 - 50		 < 司机 > array

请求参数示例

{
  "drivers": [
    {
      "driverLicenseEndTime": 1635465600,
      "driverLicenseIssuingAuthority": "机关",
      "driverLicenseNumber": "110101198803078738",
      "driverLicenseStartTime": 1603929600,
      "driverLicenseUrl": "https://oss.56fanyun.com/1.jpeg",
      "idCard": "110101198803078738",
      "idCardAddress": "地址",
      "idCardBackUrl": "https://oss.56fanyun.com/2.jpg",
      "idCardFrontUrl": "https://oss.56fanyun.com/3.jpeg",
      "name": "朱元璋",
      "note": "",
      "organizationName": "总部",
      "phoneNumber": "18256999988",
      "qualificationCertificateNumber": "110101198803078738",
      "qualificationCertificateUrlList": [
        ""
      ],
      "quasiDrivingModel": "C2"
    }
  ]
}

返回示例

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

修改司机信息接口

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

请求 URL： /driver/update

请求方式： POST

需要AccessToken： 是

调用限制： 3次/秒

请求参数：

请参考：司机

请求参数示例

{
  "driverLicenseEndTime": 1635465600,
  "driverLicenseIssuingAuthority": "机关",
  "driverLicenseNumber": "110101198803078738",
  "driverLicenseStartTime": 1603929600,
  "driverLicenseUrl": "https://oss.56fanyun.com/1.jpeg",
  "idCard": "110101198803078738",
  "idCardAddress": "地址",
  "idCardBackUrl": "https://oss.56fanyun.com/2.jpg",
  "idCardFrontUrl": "https://oss.56fanyun.com/3.jpeg",
  "name": "朱元璋",
  "note": "",
  "organizationName": "总部",
  "phoneNumber": "18256999988",
  "qualificationCertificateNumber": "110101198803078738",
  "qualificationCertificateUrlList": [
    ""
  ],
  "quasiDrivingModel": "C2"
}

返回示例

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

根据身份证号查询司机

简要描述： 根据身份证号查询司机

请求 URL： /driver/find_drivers_by_idCards

请求方式： POST

需要AccessToken： 是

调用限制： 5次/秒

请求参数：

名称 说明 类型
idCards
必填		 司机身份证号，单次最多50个
长度 : 0 - 50		 < string > array

请求参数示例

{
    "idCards": ["110101199403071590"]
}

返回示例

{
    "code": 200,
    "message": null,
    "data": {
        //身份证号
        "110101199403071590": {
            "id": "5ea240703e6b54000a95bfc2",         //主键ID
            "name": "王师傅",                          //姓名
            "phoneNumber": "18012345671",             //手机号
            "idCard": "110101199403071590",           //身份证
            "idCardStartTime": 1610582400,            //身份证生效日期
            "idCardEndTime": 1611273600,              //身份证失效日期
            "idCardAddress": "计量大厦",               //身份证住址
            "qualificationCertificateNumber": "110101199403071590",   //从业资格证
            "driverLicenseNumber": "110101199403071590",              //驾驶证编号
            "quasiDrivingModel": "A1,A3",                             //准驾车型
            "driverLicenseStartTime": 1602547200,                     //驾驶证生效日期
            "driverLicenseEndTime": 1918080000,                       //驾驶证失效日期
            "driverLicenseIssuingAuthority": "政府",                   //驾驶证发证机关
            "idCardFrontUrl": "https://oss.xiaokuaikeji.com/1.jpg",   //身份证正面图片地址
            "idCardBackUrl": "https://oss.xiaokuaikeji.com/2.jpg",    //身份证背面图片地址
            "driverLicenseUrl": "https://oss.xiaokuaikeji.com/3.jpg", //驾驶证图片地址
            "qualificationCertificateUrlList": ["https://oss.xiaokuaikeji.com/4.jpg"], //从业资格证图片地址
            "note": "司机备注1",     //备注
            "verifyStatus": 0,      //审核状态 0: 通过 1: 不通过 2: 待审核
            "created": 1587691633,  //创建时间
            "updated": 1615965234   //更新时间
        }
    }
}

车辆相关接口

批量创建车辆接口

简要描述： 批量创建车辆，如果车牌号已存在，则会更新车辆信息。 注意事项

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

请求 URL： /vehicle/batch_create

请求方式： POST

需要AccessToken： 是

调用限制： 3次/秒

请求参数：

名称 说明 类型
vehicles
必填		 车辆列表，单次最多50个
长度 : 1 - 50		 < 车辆 > array

请求参数示例

{
  "vehicles": [
    {
      "approvedLoadWeight": 20700,
      "drivingLicenseUrlList": [
        "https://oss.56fanyun.com/1.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"
    }
  ]
}

返回示例

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

修改车辆信息接口

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

请求 URL： /vehicle/update

请求方式： POST

需要AccessToken： 是

调用限制： 3次/秒

请求参数：

请参考：车辆

请求参数示例

{
  "approvedLoadWeight": 20700,
  "drivingLicenseUrlList": [
    "https://oss.56fanyun.com/1.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"
}

返回示例

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

根据车牌号查询车辆

简要描述： 根据车牌号查询车辆

请求 URL： /vehicle/find_vehicles_by_plateNumbers

请求方式： POST

需要AccessToken： 是

调用限制： 5次/秒

请求参数：

名称 说明 类型
licensePlateNumbers
必填		 车牌号，单次最多50个
长度 : 0 - 50		 < string > array

请求参数示例

{
    "licensePlateNumbers": ["晋B85118"]
}

返回示例

{
    "code": 200,
    "message": null,
    "data": {
        //车牌号
        "晋B85118": {
            "id": "5f99138716669a000a26cba3",  //主键ID
            "licensePlateNumber": "晋B85118",  //车牌号
            "vehicleOwner": "黄连银",  //车辆所有人
            "vehicleType": "重型半挂牵引车",  //车辆类型
            "vehicleTypeCode": "Q11",  //车辆类型代码
            "licensePlateColor": "黄色",  //车牌颜色
            "licensePlateColorCode": "2",  //车牌颜色代码
            "natureOfUse": "货运",  //使用性质
            "vehicleIDCode": "LFWRMUPH3F1F10155",  //车辆识别代号
            "registrationDate": 1429488000,  //注册日期
            "issueDate": 1561939200,  //发证日期
            "issuingAuthority": "山西省大同市公安局交通警察支队",  //发证机关
            "vehicleEnergyType": "柴油",  //车辆能源类型
            "vehicleEnergyTypeCode": "B",  //车辆能源类型代码
            "approvedLoadWeight": 101,  //核定载质量
            "totalWeight": 200,  //总质量
            "fileNumber": "48938934",  //档案编号
            "outlineLength": 3,  //外廓长
            "outlineWidth": 4,  //外廓宽
            "outlineHeight": 5,  //外廓高
            "trailerLicenseNumber": "",  //挂车牌照号
            "roadTransportCertificate": "140213002622",  //道路运输证号
            "merchantName": "黄连银",  //业户名称
            "roadTransportLicenseNumber": "1402130000003",  //道路运输经营许可证号
            "drivingLicenseUrlList": ["https://oss.xiaokuaikeji.com/1.jpg"],  //行驶证照片
            "roadTransportPermitUrlList": ["https://oss.xiaokuaikeji.com/2.png"],  //道路运输证照片
            "note": "车辆备注",  //备注
            "verifyStatus": 0,  //审核状态 0: 通过 1: 不通过 2: 待审核
            "created": 1603867527,  //创建时间
            "updated": 1615980914  //更新时间
        }
    }
}

收款人相关接口

批量创建收款人接口

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

请求 URL： /payee/batch_create

请求方式： POST

需要AccessToken： 是

调用限制： 3次/秒

请求参数：

名称 说明 类型
payees
必填		 收款人列表，单次最多50个
长度 : 1 - 50		 < 收款人 > array

请求参数示例

{
  "payees": [
    {
      "bankCardNumber": "99030650508000212005",
      "bankName": "浙江网商银行",
      "idCard": "422432199210022595",
      "name": "马良",
      "note": "",
      "organizationName": "总部",
      "phoneNumber": "15527162085"
    }
  ]
}

返回示例

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

修改收款人信息接口

简要描述： 修改收款人信息，根据银行卡号更新对应收款人的信息

请求 URL： /payee/update

请求方式： POST

需要AccessToken： 是

调用限制： 3次/秒

请求参数：

名称 说明 类型
bankCardNumber
必填		 银行卡号，该字段为收款人的唯一标识 string
bankName
可选		 开户银行，支持的银行请参考《部网络货运信息交互系统代码集》 string
phoneNumber
可选		 手机号，不填则置空
长度 : 11		 string
note
可选		 备注，不填则置空
长度 : 1 - 200		 string

请求参数示例

{
    "bankCardNumber": "99030650508000212005",
    "bankName": "浙江网商银行",
    "idCard": "422432199210022595",
    "name": "马良",
    "note": "",
    "organizationName": "总部",
    "phoneNumber": "15527162085"
}

返回示例

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

承运人（经纪人）相关接口

创建承运人（经纪人）接口

简要描述： 创建承运人（经纪人）接口。 注意事项

  1. 承运人（经纪人）姓名和身份证号必须真实一致

请求 URL： /open_middleman/create

请求方式： POST

需要AccessToken： 是

调用限制： 3次/秒

请求参数：

名称 说明 类型
middleman
必填		 承运人（经纪人）信息 承运人（经纪人） Object
organizationName
可选		 组织机构名称，会创建至对应组织机构下，默认创建到总部 string

请求参数示例

{
  "middleman": {
    "idCard": "110101198603073270",
    "idCardAddress": "浙江省杭州市西湖区xxxx",
    "idCardFrontUrl": "https://oss.56fanyun.com/1.jpg",
    "idCardReverseUrl": "https://oss.56fanyun.com/2.jpg",
    "name": "李四三",
    "phoneNumber": "18058718162",
    "remark": ""
  },
  "organizationName": "总部"
}

返回示例

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

财务类接口

核销接口(全部核销)

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

请求 URL： /writeoff/writeoff

请求方式： POST

需要AccessToken： 是

调用限制： 120次/分钟

请求参数：

名称 说明 类型
carNumber
必填		 车牌号码
长度 : 1 - 35		 string
customerOrderNumbers
必填		 结算受理单列表 < string > array
driverName
必填		 司机名称
长度 : 1 - 30		 string
driverPhone
必填		 司机电话
长度 : 1 - 18		 string
payFreight
必填		 支付金额
最小值 : 0
最大值 : 999999		 number (double)
payType
必填		 支付方式，1：油卡，3：支付宝，4：微信，5：银行转账，6：其它 integer (int32)
payee
运单有关联收款人时可选		 收款人，默认用运单司机关联的收款人，如果受理单没有关联收款人，这里必填 收款人
tradeNo
必填		 资金流水号
长度 : 1 - 50		 string
note
可选		 付款备注
长度 : 0 - 256		 string

请求参数示例

{
  "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"
}

返回示例

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

撤销核销接口

简要描述： 撤销核销

请求 URL： /writeoff/cancel

请求方式： POST

需要AccessToken： 是

调用限制： 120次/分钟

请求参数：

名称 说明 类型
customerOrderNumbers
必填		 结算受理单列表，一次最多20单
样例 : [ "XXX", "XXX" ]		 < string > array

请求参数示例

{
  "customerOrderNumbers": [
    "S2011181700651710"
  ]
}

返回示例

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

创建司机费用结算单接口

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

请求 URL： /finance_driver_fee/save_settlement

请求方式： POST

需要AccessToken： 是

调用限制： 180次/分钟

请求参数：

名称 说明 类型
customerOrderNumbers
必填		 结算受理单列表
样例 : [ "XXX", "XXX" ]		 < string > array
name
必填		 司机姓名 string
phone
必填		 司机电话 string
organizationName
必填		 经办机构名称 string
payee
可选		 收款人信息
如果填写则会更改运单的收款人为此收款人，如果收款人已存在，只需填写银行卡号即可，如果不存在则需填写其余必填信息，会自动创建收款人并关联至运单		 收款人

请求参数示例

{
  "customerOrderNumbers": [
    "S2011181700651710"
  ],
  "name": "冯大大",
  "phone": "13064797352",
  "organizationName": "总部"
}

返回示例

{
    "code": 200,
    "data": "CJ2103231054442628",
    "message": null
}

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

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

请求 URL： /finance_driver_fee/get_driver_fee_settlement

请求方式： GET

需要AccessToken： 是

调用限制： 180次/分钟

请求参数：

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

请求参数示例

{
  "settlementNumber": "CJ2011101349979601"
}

返回示例

{
  "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
  }
}

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

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

请求 URL： /finance_driver_fee/write_off

请求方式： POST

需要AccessToken： 是

调用限制： 180次/分钟

请求参数：

名称 说明 类型
settlementNumber
必填		 结算单号 string
payFreight
必填		 支付金额 number(double)
packCount
必填		 车次数 number
payType
必填		 支付方式: 1：油卡，3：支付宝，4：微信，5：银行转账，6：其它 integer (int32)
tradeNo
可选		 资金流水号, 油卡支付时不用传 string
note
必填		 备注 string

请求参数示例

{
  "settlementNumber": "",
  "payFreight": 100.01,
  "packCount": 1,
  "payType": 5,
  "tradeNo": "2323232323",
  "note": ""
}

返回示例

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

财务类接口(撮合)

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

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

请求 URL： /finance_driver_fee_match_up/save_settlement

请求方式： POST

需要AccessToken： 是

调用限制： 180次/分钟

请求参数：

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

请求参数示例

{
  "customerOrderNumbers": [
    "S2011181700651710"
  ],
  "name": "冯大大",
  "phone": "13064797352",
  "organizationName": "总部"
}

返回示例

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

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

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

请求 URL： /finance_driver_fee_match_up/get_driver_fee_settlement

请求方式： GET

需要AccessToken： 是

调用限制： 180次/分钟

请求参数：

名称 说明 类型
settlementNumber
必填		 结算单单号 string

请求参数示例

{
  "settlementNumber": "CJ2011101349979601"
}

返回示例

{
  "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
  }
}

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

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

请求 URL： /finance_driver_fee_match_up/write_off

请求方式： POST

需要AccessToken： 是

调用限制： 180次/分钟

请求参数：

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

请求参数示例

{
  "settlementNumber": "",
  "payFreight": 100.01,
  "packCount": 1,
  "payType": 5,
  "tradeNo": "2323232323",
  "note": ""
}

返回示例

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

合同类接口

创建承运人合同接口

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

请求 URL： /contract/driver/create

请求方式： POST

需要AccessToken： 是

调用限制： 3次/秒

请求参数：

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

请求参数示例

{
  "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"
}

返回示例

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

创建委托代收合同接口

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

请求 URL： /contract/middleman/create

请求方式： POST

需要AccessToken： 是

调用限制： 3次/秒

请求参数：

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

请求参数示例

{
  "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"
}

返回示例

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

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

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

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

请求方式： POST

需要AccessToken： 是

调用限制： 3次/秒

请求参数：

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

请求参数示例

{
  "orderNumber": "S2011181700651710",
  "number": "HT00001",
  "name": "冯测",
  "phone": "13064797352",
  "certNo": "110101196603072412",
  "contractDate": "2020-01-01",
  "fileUrl": "https://www.a.com/z.pdf"
}

返回示例

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

创建自营单票承运人合同接口

简要描述： 创建自营单票承运人合同接口

请求 URL： /contract/single_contract/create

请求方式： POST

需要AccessToken： 是

调用限制： 3次/秒

请求参数：

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

请求参数示例

{
  "orderNumber": "S2011181700651710",
  "number": "HT00001",
  "name": "冯测",
  "phone": "13064797352",
  "certNo": "110101196603072412",
  "contractDate": "2020-01-01",
  "fileUrl": "https://www.a.com/z.pdf"
}

返回示例

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

实名认证类接口

实名认证接口

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

请求 URL： /ocr/face_match

请求方式： POST

需要AccessToken： 是

调用限制： 100次/天

请求参数：

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

请求参数示例

{
  "name": "冯大大",
  "certNo": "110101196603072412",
  "certImg": "base64",
  "headImg": "base64"
}

返回示例

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

位置信息类接口

上报运单轨迹接口

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

  1. 使用此接口上传轨迹的公司，建议在网络货运系统中清空中交账号的配置，否则轨迹可能会乱

请求 URL： /gps/report_gps_data_for_order

请求方式： POST

需要AccessToken： 是

调用限制： 120次/分钟

请求参数：

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

请求参数示例

{
  "orderNumber": "S2011181700651710",
  "gpsDataList": [
    {
      "longitude": 116.405289,
      "latitude": 39.904987,
      "locateTime": 1604970800,
      "locateType": 1,
      "runStatus": 1
    }
  ]
}

返回示例

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

接口参数说明

运单

名称 说明 类型
orderNumber
更新运单时必填		 运单号，更新运单时必填，创建运单时不需要填写 string
weightUnit
更新运单时选填		 重量单位，默认为千克，可选值：0=千克，1=吨（创建运单时不需要填写，取系统内高级设置中设置的重量单位） integer (int32)
originalOrderNumber
必填		 客户单号
长度 : 1 - 50		 string
businessType
与businessTypeCode二选一必填		 业务类型
可选值 : 干线普货运输, 城市配送, 农村配送, 集装箱运输, 其他		 string
businessTypeCode
与businessType二选一必填		 业务类型代码，优先使用该值
可选值 : 请参考《部网络货运信息交互系统代码集》		 string
consignerName
必填		 发货人姓名
长度 : 1 - 45		 string
consignerPhone
必填		 发货人电话
长度 : 1 - 20		 string
consignerAddress
必填		 发货人地址 地址
consignerIdCard
必填		 发货人证件号
长度 : 1 - 35		 string
consigneeName
必填		 收货人姓名
长度 : 1 - 45		 string
consigneePhone
必填		 收货人电话
长度 : 1 - 20		 string
freightIn
必填		 运单运费信息 运单运费
consigneeAddress
必填		 收货人地址 地址
cargoList
必填		 货物列表 < 货物 > array
carrier
可选		 承运人 承运人
payee
可选		 收款人 收款人
consigneeIdCard
可选		 收货人证件号
长度 : 0 - 35		 string
appointArriveTime
可选		 预约送达时间。时间戳 integer (int32)
openTime
可选		 开单时间。时间戳 integer (int32)
deliveryTime
可选		 提货时间。时间戳 integer (int32)
deliveryType
可选		 提送类型。1：自提；2：送货 integer (int32)
endAddress
可选		 目的地
长度 : 0 - 20		 string
note1
可选		 自定义备注1 string
note2
可选		 自定义备注2 string
note3
可选		 自定义备注3 string
note4
可选		 自定义备注4 string
note5
可选		 自定义备注5 string
note6
可选		 自定义备注6 string
note7
可选		 自定义备注7 string
note8
可选		 自定义备注8 string
note9
可选		 自定义备注9 string
note10
可选		 自定义备注10 string
note11
可选		 自定义备注11 string
note12
可选		 自定义备注12 string
paymentCollect
可选		 代收货款
最小值 : 0
最大值 : 999999		 number (double)
receiptCount
可选		 回单数
最小值 : 0
最大值 : 999		 integer (int32)
remarks
可选		 备注
长度 : 1 - 250		 string
salesman
可选		 业务员
长度 : 0 - 20		 string
salesmanPhone
可选		 业务员电话
长度 : 0 - 12		 string
settlementName
可选		 结算方名称
长度 : 0 - 50		 string
settlementPhone
可选		 结算方电话
长度 : 0 - 20		 string
startAddress
可选		 起始地
长度 : 0 - 20		 string
project
可选		 项目 string
device
可选		 设备号，填入后运单会绑定该设备，否则绑定承运人信息中的车牌号 string
loadImages
可选		 装货图片，最多9张，图片地址必须以http://或https://开头 < string > array
unloadImages
可选		 卸货图片，最多9张，图片地址必须以http://或https://开头 < string > array

撮合运单

名称 说明 类型
originalOrderNumber
必填		 客户单号
长度 : 1 - 50		 string
businessType
与businessTypeCode二选一必填		 业务类型
可选值 : 干线普货运输, 城市配送, 农村配送, 集装箱运输, 其他		 string
businessTypeCode
与businessType二选一必填		 业务类型代码，优先使用该值
可选值 : 请参考《部网络货运信息交互系统代码集》		 string
consignerName
必填		 发货人姓名
长度 : 1 - 45		 string
consignerPhone
必填		 发货人电话
长度 : 1 - 20		 string
consignerAddress
必填		 发货人地址 地址
consignerIdCard
必填		 发货人证件号
长度 : 1 - 35		 string
consigneeName
必填		 收货人姓名
长度 : 1 - 45		 string
consigneePhone
必填		 收货人电话
长度 : 1 - 20		 string
consigneeAddress
必填		 收货人地址 地址
consigneeIdCard
可选		 收货人证件号
长度 : 0 - 35		 string
cargoList
必填		 货物列表 < 货物 > array
carrier
可选		 承运人 承运人
payee
可选		 收款人 收款人
appointArriveTime
可选		 预约送达时间。时间戳 integer (int32)
openTime
可选		 开单时间。时间戳 integer (int32)
deliveryTime
可选		 提货时间。时间戳 integer (int32)
deliveryType
可选		 提送类型。1：自提；2：送货 integer (int32)
endAddress
可选		 目的地
长度 : 0 - 20		 string
note1
可选		 自定义备注1 string
note2
可选		 自定义备注2 string
note3
可选		 自定义备注3 string
note4
可选		 自定义备注4 string
note5
可选		 自定义备注5 string
note6
可选		 自定义备注6 string
note7
可选		 自定义备注7 string
note8
可选		 自定义备注8 string
note9
可选		 自定义备注9 string
note10
可选		 自定义备注10 string
note11
可选		 自定义备注11 string
note12
可选		 自定义备注12 string
paymentCollect
可选		 代收货款
最小值 : 0
最大值 : 999999		 number (double)
receiptCount
可选		 回单数
最小值 : 0
最大值 : 999		 integer (int32)
remarks
可选		 备注
长度 : 1 - 250		 string
salesman
可选		 业务员
长度 : 0 - 20		 string
salesmanPhone
可选		 业务员电话
长度 : 0 - 12		 string
startAddress
可选		 起始地
长度 : 0 - 20		 string
project
可选		 项目 string
device
可选		 设备号，填入后运单会绑定该设备，否则绑定承运人信息中的车牌号 string
loadImages
可选		 装货图片，最多9张，图片地址必须以http://或https://开头 < string > array
unloadImages
可选		 卸货图片，最多9张，图片地址必须以http://或https://开头 < string > array

货物

名称 说明 类型
name
必填		 货物名称
长度 : 1 - 150		 string
type
与typeCode二选一必填		 货物类型名称 可选值请参考《部网络货运信息交互系统代码集》
typeCode
与type二选一必填		 货物类型代码，优先使用该值 可选值请参考《部网络货运信息交互系统代码集》
weight
必填		 重量(千克/吨, 查看网络货运系统中“高级设置设置-默认重量单位”)
最小值 : >1
最大值 : <99000		 number (double)
quantity
可选		 件数
最小值 : 0
最大值 : 999999		 number (double)
value
可选		 货值
最小值 : 0
最大值 : 9999999		 number (double)
volume
可选		 体积
最小值 : 0
最大值 : 999		 number (double)
unloadWeight
可选		 卸货重量(千克/吨, 查看网络货运系统中“高级设置设置-默认重量单位”)
最小值 : 0
最大值 : <99000		 number (double)
unloadQuantity
可选		 卸货件数
最小值 : 0
最大值 : 999999		 number (double)
unloadVolume
可选		 卸货体积
最小值 : 0
最大值 : 999		 number (double)
productModel
可选		 货物备注
长度 : 0 - 100		 string
note1
可选		 自定义备注1 string
note2
可选		 自定义备注2 string
note3
可选		 自定义备注3 string
note4
可选		 自定义备注4 string
note5
可选		 自定义备注5 string
note6
可选		 自定义备注6 string

承运人

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

受理单收款人

名称 说明 类型
name
必填		 银行开户名
长度 : 1 - 20		 string
bankCardNumber
必填		 银行卡号 string
bankName
必填		 开户银行，支持的银行请参考《部网络货运信息交互系统代码集》 string
idCard
必填		 身份证
长度 : 18		 string
phoneNumber
可选		 手机号
长度 : 11		 string
accountType
可选		 账户类型，0：银行账户(默认)，另外三种类型创建后不会在收款人管理中展示：4：第三方支付平台，41：支付宝支付，42：微信支付 string

地址

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

名称 说明 类型
address
必填		 地址
长度 : 1 - 100		 string
province
与districtCode二选一必填		 省，填写行政区划代码后可以不填写该值 string
city
与districtCode二选一必填		 市，填写行政区划代码后可以不填写该值 string
district
与districtCode二选一必填		 区/县，填写行政区划代码后可以不填写该值 string
districtCode
与省市区信息二选一必填		 行政区划代码，必须填区级的区划代码，填写此值后可以不填写省市区信息，会根据区划代码反查出省市区的信息 string
lat
可选		 纬度，必须使用高德的坐标系（即GCJ-02火星坐标系），其余坐标系需自行做转换 number (double)
lng
可选		 经度，必须使用高德的坐标系（即GCJ-02火星坐标系），其余坐标系需自行做转换 number (double)

运单运费

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

司机

名称 说明 类型
idCard
必填		 身份证，该字段为司机的唯一标识 string
name
必填		 姓名
长度 : 1 - 20		 string
phoneNumber
必填		 手机号
长度 : 11		 string
idCardAddress
必填		 身份证地址
长度 : 1 - 80		 string
driverLicenseIssuingAuthority
必填		 驾驶证发证机关
长度 : 1 - 50		 string
driverLicenseNumber
必填		 驾驶证编号
长度 : 1 - 18		 string
driverLicenseStartTime
必填		 驾驶证有效期开始时间，时间戳，精确到秒 integer (int64)
driverLicenseEndTime
必填		 驾驶证有效期结束时间，时间戳，精确到秒，如果为长期，请填写-1 integer (int64)
qualificationCertificateNumber
必填		 从业资格证号
长度 : 1 - 19		 string
quasiDrivingModel
必填		 准驾车型, 可选车型["A1", "A2", "A3", "B1", "B2", "C1", "D", "E"], 多个准驾车型以逗号隔开, 例："A1,A2"
长度 : 1 - 20		 string
idCardStartTime
可选		 身份证生效日期，时间戳，精确到秒 integer (int64)
idCardEndTime
可选		 身份证失效日期，时间戳，精确到秒，如果为长期，请填写-1 integer (int64)
organizationName
可选		 组织机构名称，会创建至对应组织机构下，默认创建到总部 string
idCardBackUrl
可选		 身份证背面图片地址 string
idCardFrontUrl
可选		 身份证正面图片地址 string
driverLicenseUrl
可选		 驾驶证图片地址 string
qualificationCertificateUrlList
可选		 从业资格证图片地址，最多传输4张 < string > array
note
可选		 备注
长度 : 0 - 250		 string

车辆

名称 说明 类型
licensePlateNumber
必填		 车牌号，该字段为车辆的唯一标识
长度 : 1 - 10		 string
vehicleOwner
必填		 车辆所有人
长度 : 1 - 50		 string
issuingAuthority
必填		 发证机关
长度 : 1 - 50		 string
merchantName
必填		 业户名称 string
natureOfUse
必填		 使用性质，只能为中文字符
长度 : 2 - 20		 string
licensePlateColor
与licensePlateColorCode二选一必填		 车牌颜色，和车牌颜色代码对应，两个中必填一个，优先使用本字段的值，代码集请参考《部网络货运信息交互系统代码集》 string
licensePlateColorCode
与licensePlateColor二选一必填		 车牌颜色代码，和车牌颜色对应 string
vehicleType
与vehicleTypeCode二选一必填		 车辆类型，和车辆类型代码对应，两个中必填一个，优先使用本字段的值，代码集请参考《部网络货运信息交互系统代码集》 string
vehicleTypeCode
与vehicleType二选一必填		 车辆类型代码，和车辆类型对应 string
vehicleEnergyType
与vehicleEnergyTypeCode二选一必填		 车辆能源类型，和车辆能源类型代码对应，两个中必填一个，优先使用本字段的值，代码集请参考《部网络货运信息交互系统代码集》 string
vehicleEnergyTypeCode
与vehicleEnergyType二选一必填		 车辆能源类型代码，和车辆能源类型对应 string
issueDate
必填		 发证日期，时间戳，精确到秒 integer (int64)
registrationDate
必填		 注册日期，时间戳，精确到秒 integer (int64)
roadTransportCertificate
必填		 道路运输证号
长度 : 1 - 12		 string
roadTransportLicenseNumber
必填		 道路运输经营许可证号 string
totalWeight
必填		 总质量，单位：千克
最小值 : 1		 integer (int32)
approvedLoadWeight
必填		 核定载质量，单位：千克
最小值 : 1		 integer (int32)
vehicleIDCode
必填		 车辆识别代码
长度 : 1 - 20		 string
organizationName
可选		 组织机构名称，会创建至对应组织机构下，默认创建到总部 string
fileNumber
可选		 档案编号
长度 : 0 - 20		 string
note
可选		 备注
长度 : 0 - 250		 string
outlineHeight
可选		 外廓高，单位：毫米
最小值 : 1		 integer (int32)
outlineLength
可选		 外廓长，单位：毫米
最小值 : 1		 integer (int32)
outlineWidth
可选		 外廓宽，单位：毫米
最小值 : 1		 integer (int32)
drivingLicenseUrlList
可选		 行驶证照片，最多传输4张 < string > array
roadTransportPermitUrlList
可选		 道路运输证照片，最多传输4张 < string > array
trailerLicenseNumber
可选		 挂车牌照号，车型为牵引车类型时必填
长度 : 0 - 10		 string

收款人

名称 说明 类型
bankCardNumber
必填		 银行卡号，该字段为收款人的唯一标识 string
name
必填		 银行开户名
长度 : 1 - 20		 string
bankName
必填		 开户银行，支持的银行请参考《部网络货运信息交互系统代码集》 string
idCard
必填		 身份证 string
accountType
可选		 账户类型，0：银行账户(默认)，另外三种类型创建后不会在收款人管理中展示：4：第三方支付平台，41：支付宝支付，42：微信支付 string
organizationName
可选		 组织机构名称，会创建至对应组织机构下，默认创建到总部 string
phoneNumber
可选		 手机号
长度 : 11		 string
note
可选		 备注
长度 : 1 - 200		 string

承运人（经纪人）

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

位置信息

名称 说明 类型
longitude
必填		 经度，必须使用高德的坐标系（即GCJ-02火星坐标系），其余坐标系需自行做转换 number (double)
latitude
必填		 纬度，必须使用高德的坐标系（即GCJ-02火星坐标系），其余坐标系需自行做转换 number (double)
locateTime
必填		 定位时间（时间戳，精确到秒），定位时间必须在设备运输时间范围内（开单时间和签收时间之间，未签收时为开单时间到开单时间往后45天之间） integer (int32)
locateType
必填		 定位类型，固定传1即可 integer (int32)
runStatus
必填		 设备运行状态（1:行驶，2:停止，3:离线） integer (int32)
addr
可选		 设备完整定位地址，包含省市区
例 : 浙江省杭州市西湖区计量大厦		 string
province
可选		 定位省份 string
city
可选		 定位城市 string
roadName
可选		 定位街道 string
speed
可选		 设备速度（单位：km／h） number (double)
direction
可选		 设备运动方向（单位：角度） number (double)
temperature
可选		 设备温度（单位：度） number (double)
humidity
可选		 设备湿度（单位：度） number (double)
powerRate
可选		 设备电量（单位：%） integer (int32)