快货运Open Api

# 创建承运人信息

接口名称：/open_middleman/create

请求参数

序号 层级 英文名称 中文名称 类型 长度 必填 说明
1 1 name 名称 [企业名称/承运人名称] String 20 是 type20，2-20 个字符，只允许汉字+少数民族符号 · ；type10，2-20 个字符，允许汉字，字母，数字，全角括号（企业承运人，只有自营企业支持）
2 1 idCard 证件号码 [社会统一信用代码 / 身份证号码] String 18 是 type20，18 位数字（末尾允许输入 X），符合身份证号校验算法；type10， 传入字段需满足 统一社会信用代码校验算法（企业承运人，只有自营企业支持）
3 1 phone 联系电话 / 手机号码 String 20 type = 20 必填 type20 只支持手机号码；type10 支持 座机 或 手机号码
4 1 idCardFrontFilename 身份证正面照 Filename String 255 type = 20 必填 文件名
5 1 idCardBackFilename 身份证背面照 Filename String 255 type = 20 必填
6 1 idCardBeginTime 身份证有效期开始时间 Long 否 时间戳，精确到毫秒
7 1 idCardEndTime 身份证有效期结束时间 Long 否
8 1 address 地址 String 255 是 2-256 个字符，个人承运人填身份证地址，企业承运人填企业地址
9 1 type 类型： 10-企业，20-个人 Integer 4 是 type10，只允许自营模式企业传入，自营平台及撮合平台模式不支持
10 1 businessLicenseFilename 营业执照 Filename String 255 否 文件名
11 1 bankDeposit 开户银行 String 20 type = 10 必填 传入银行名称，无需限制于《银行列表》
12 1 bankCardNumber 银行账号 String 21 type = 10 必填 13-21 位数字
13 1 branch 银行支行 String 64 type = 10 必填 传入支行名称
14 1 legalName 法人姓名 String 20 type = 10 非必填 2-20 个字符，只允许汉字+少数民族符号 ·
15 1 transportBusinessLicenseFilename 道路运输经营许可证号 filename String 255 type = 10 必填 文件名
16 1 transportBusinessLicenseOtherFilename 道路运输经营许可证其他页 filename String 255 type = 10 非必填
17 1 transportBusinessLicense 道路运输经营许可证号 String 20 type = 10 必填 12-20 位数字
18 1 businessHouseholdsName 业户名 String 20 type = 10 必填 2-20 个字符，允许数字，字母，汉字，全角括号，少数民族符号 ·

示例

{
  "address": "string",
  "bankCardNumber": "string",
  "bankDeposit": "string",
  "branch": "string",
  "businessHouseholdsName": "string",
  "businessLicenseFilename": "string",
  "idCard": "string",
  "idCardBackFilename": "string",
  "idCardBeginTime": 1624519901584,
  "idCardEndTime": 1624519901584,
  "idCardFrontFilename": "string",
  "legalName": "string",
  "name": "string",
  "phone": "string",
  "transportBusinessLicense": "string",
  "transportBusinessLicenseFilename": "string",
  "transportBusinessLicenseOtherFilename": "string",
  "type": 0
}

返回参数

true

mock 数据示例

{
    "code": "00000",
    "message": "调用成功",
    "data": true
}

# 更新承运人信息

接口名称：/open_middleman/update

请求参数

序号 层级 英文名称 中文名称 类型 长度 必填 说明
1 1 idCard 证件号码 String 18 是 type20，18 位数字（末尾允许输入 X），符合身份证号校验算法；type10， 传入字段需满足 统一社会信用代码校验算法（企业承运人，只有自营企业支持）
2 1 phone 联系电话/手机号码 String 20 否 type20 只支持手机号码；type10 支持 座机 或 手机号码
3 1 legalName 法人姓名 String 20 否 2-20 个字符，只允许汉字+少数民族符号 ·
4 1 businessLicenseFilename 营业执照 filename String 255 否 文件名
5 1 transportBusinessLicenseFilename 道路运输经营许可证号 filename String 255 否 文件名
6 1 transportBusinessLicenseOtherFilename 道路运输经营许可证其他页 filename String 255 否
7 1 idCardBeginTime 身份证有效期开始时间 Long 否 时间戳，精确到毫秒
8 1 idCardEndTime 身份证有效期结束时间 Long 否

示例

{
  "idCard": "string",
  "phone": "string",
  "legalName": "string",
  "businessLicenseFilename": "string",
  "idCardBeginTime": 1624519901584,
  "idCardEndTime": 1624519901584,
  "transportBusinessLicenseFilename": "string",
  "transportBusinessLicenseOtherFilename": "string"
}

返回参数

true

mock 数据示例

{
"code": "00000",
"message": "调用成功",
"data": true
}

# 查询承运人信息

接口名称：/open_middleman/search

请求参数

序号 层级 英文名称 中文名称 类型 长度 必填 说明
1 1 carrierName 承运人名称 String 20 否 type20，2-20 个字符，只允许汉字+少数民族符号 · ；type10，2-20 个字符，允许汉字，字母，数字，全角括号（企业承运人，只有自营企业支持）
2 1 idCard 证件号码 String 18 否 type20，18 位数字（末尾允许输入 X），符合身份证号校验算法；type10， 传入字段需满足 统一社会信用代码校验算法（企业承运人，只有自营企业支持）

示例

{
  "carrierName": "string",
  "idCard": "string"
}

返回参数

序号 层级 英文名称 中文名称 类型
1 1 id 主键 id Long
2 1 name 姓名 String
3 1 idCard 身份证号码（个人承运人）/ 社会统一信用代码（企业承运人） String
4 1 phone 手机号码 String
5 1 idCardFrontFilename 身份证正面照 String
6 1 idCardBackFilename 身份证背面 String
7 1 idCardBeginTime 身份证有效期开始时间 Long
8 1 idCardEndTime 身份证有效期结束时间 Long
9 1 address 地址 String
10 1 type 类型： 10-企业，20-个人，30-司机 Integer
11 1 businessLicenseFilename 营业执照 url String
12 1 bankDeposit 开户银行 String
13 1 bankCardNumber 银行账号 String
14 1 branch 银行支行 String
15 1 legalName 法人姓名 String
16 1 transportBusinessLicenseFilename 道路运输经营许可证号 filename String
17 1 transportBusinessLicenseOtherFilename 道路运输经营许可证其他页 filename String
18 1 transportBusinessLicense 道路运输经营许可证号 String
19 1 businessHouseholdsName 业户号 String
20 1 createTime 创建时间 Long
21 1 creatorCompanyId 创建企业 ID Long
22 1 payeeState 在线账户状态: -1:待开户；0：开户中；1：可用；2：开户失败；3：已禁用；4：已开户待验证 Integer
23 1 contractStatus 合同状态: 0-未签约，1-等待签约，2-有效，3-快到期，4-已到期，5-作废 Integer

mock 数据示例

{
  "code": "00000",
  "data": [
    {
      "id": 18,
      "name": "string",
      "idCard": "string",
      "phone": "string",
      "idCardFrontFilename": "string",
      "idCardBackFilename": "string",
      "idCardBeginTime": 1609430400000,
      "idCardEndTime": 1767196800000,
      "address": "string",
      "type": 20,
      "businessLicenseFilename": null,
      "bankDeposit": null,
      "bankCardNumber": null,
      "branch": null,
      "legalName": null,
      "transportBusinessLicenseFilename": null,
      "transportBusinessLicenseOtherFilename": null,
      "transportBusinessLicense": null,
      "businessHouseholdsName": null,
      "createTime": 1621256258000,
      "creatorCompanyId": 1,
      "payeeState": 1,
      "contractStatus": 1
    }
  ],
  "message": "请求成功"
}

← 收款账户 →