快货运Open Api

# 查询承运合同

接口名称：/contract/carrier/search

请求参数

序号 层级 英文名称 中文名称 类型 长度 必填
1 1 carrierName 承运人名称 String 20 否，承运人名称和证件号至少传一个
2 1 idCard 证件号码 String 18 否，承运人名称和证件号至少传一个
3 1 transportBillNumber 运单号 String 20 否

mock 示例：

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

返回参数

序号 层级 英文名称 中文名称 类型
1 1 id 合同 id Long
2 1 companyId 发起合同签订的企业(只有该企业才能修改该合同) Long
3 1 companyName 企业名称 String
4 1 taxSourceId 税源地 id Long
5 1 taxSourceCompanyName 税源地公司名称 String
6 1 carrierName 承运人名称 String
7 1 idCard 证件号 String
8 1 contractNo 合同编号 String
9 1 signType 签约类型，1-线下，2-线上 Integer
10 1 bizType 业务模式，1-自营，2-撮合 Integer
11 1 type 合同类型，1-框架，2-单票 Integer
12 1 state 合同状态，0-未签约，1-签约中，2-有效，3-快到期，4-已到期，5-作废 Integer
13 1 invalidReason 作废原因，1-手动作废，2-超时未签 Integer
14 1 beginTime 合同开始时间 Long
15 1 endTime 合同结束时间 Long
16 1 signTime 签约时间 Long
17 1 attachment 附件 String
18 1 extendInfo 拓展信息，如果为单票合同，该字段为运单号 String

mock 示例：

{
  "code": "00000",
  "data": [
    {
      "attachment": "string",
      "beginTime": 1624517390038,
      "bizType": 0,
      "carrierId": 0,
      "carrierName": "string",
      "companyId": 0,
      "companyName": "string",
      "contractNo": "string",
      "endTime": 1624517390038,
      "id": 0,
      "idCard": "string",
      "invalidReason": 0,
      "signTime": 1624517390038,
      "signType": 0,
      "state": 0,
      "taxSourceCompanyName": "string",
      "taxSourceId": 0,
      "type": 0,
      "extendInfo": "string"
    }
  ],
  "message": "string"
}

# 承运合同短信签约回调

接口名称：carrierContractSmsNotify

回调参数

序号 层级 英文名称 中文名称 类型 长度 必填
1 1 apiId apiId String 20 否
2 1 serviceName 服务名称 String 20 否
3 1 carrierContractDTO 承运人合同 Object 否
4 2 carrierName 承运人名称 String 20 否
5 2 carrierIdCard 承运人证件号 String 18 否
6 2 contractNo 合同编号 String 20 否
7 2 contractUrl 签约地址 String 200 否

mock 示例：

{
  "apiId":"String",
  "serviceName":"carrierContractSmsNotify",
  "carrierContractDTO":{
    "carrierName": "string",
    "carrierIdCard": "string",
    "contractNo": "string",
    "contractUrl":"String"
  }
  
}

返回参数

序号 层级 英文名称 中文名称 类型
1 1 code 编码 String
2 1 message 消息 String

mock 示例：

{
  "code": "1",
  "message": ""
}

# 承运合同签约回调

接口名称：carrierContractSignNotify

回调参数

序号 层级 英文名称 中文名称 类型 长度 必填
1 1 apiId apiId String 20 否
2 1 serviceName 服务名称 String 20 否
3 1 carrierContractDTO 承运人合同 Object 否
4 2 carrierName 承运人名称 String 20 否
5 2 carrierIdCard 承运人证件号 String 18 否
6 2 contractNo 合同编号 String 20 否
7 2 success 是否签约成功 Boolean 1 否
8 2 contractUrl 合同地址 String 200 否

mock 示例：

{
  "apiId":"String",
  "serviceName":"carrierContractSignNotify",
  "carrierContractDTO":{
    "carrierName": "string",
    "carrierIdCard": "string",
    "contractNo": "string",
    "success": true,
    "contractUrl":"String"
  }
  
}

返回参数

序号 层级 英文名称 中文名称 类型
1 1 code 编码 String
2 1 message 消息 String

mock 示例：

{
  "code": "1",
  "message": ""
}

# 新增线上承运合同

接口名称：/contract/carrier/addOnline

请求参数

序号 层级 英文名称 中文名称 类型 长度 必填 说明
1 1 carrierIdCard 承运人证件号 String 18 是 身份证 或 统一社会信用代码
2 1 transportBillNumber 运单号 String 20 否 单票合同必填

mock 示例：

{
  "carrierIdCard": "string",
  "transportBillNumber": "string"
}

返回参数

序号 层级 英文名称 中文名称 类型 长度 必填 说明
1 1 contractNo 合同编号 String 是 合同编号
2 1 shortUrl 合同签约短链 String 255 是 合同签约短链
3 1 carrierIdCard 承运人证件号 String 18 是 身份证 或 统一社会信用代码
4 1 transportBillNumber 运单号 String 20 是 运单号

mock 示例：

{
    "code": "00000",
    "data": {
        "carrierIdCard": "string",
        "contractNo": "string",
        "transportBillNumber": "string",
        "shortUrl": "String"
    },
    "message": "请求成功"
}

← 车老板核验 →