API 文档

Appearance

运单运抵 ​

请求地址 ​

https://www.xxyb.cn/union/api/connection/operateArrival

注意事项 ​

请在运单支付完成后上报,推送后不支持修改运单数据，如果涉及ETC发票，需要等ETC发票开出来后再调运抵接口上传所有数据，ETC发票也要推送过来，因etc票和油卡发票可单独做抵扣，司机运费请用户上传扣减掉油卡部分后的金额

参数名必选类型说明
token是string应用令牌
cid是string合作ID
corpId是string企业ID

请求参数 ​

ApiWaybillArrivalReq 运单运抵请求 ​

字段类型层级描述必填
bodyIdString1主体编号是
waybillArrivalDomainApiWaybillArrivalDomain1运单信息是
contractBasicDomainList<ApiContractBasicDomain>1合同信息是
trackDomainList<ApiTrackDomain>1轨迹信息是
financialDomainsList<ApiFinancialDomain>1支付信息是
etcInvoiceDomainsList<ApiEtcInvoiceDomain>1etc发票信息否

ApiWaybillArrivalDomain 运单运抵信息 ​

字段类型层级描述必填
shippingNoteNumberString2运单号是
transportTypeCodeString2运输组织类型代码是
businessTypeCodeString2业务类型代码是
goodsArrangementTypeCodeString2运输组货方式代码是
arrivalTimeString2运单运抵时间 格式yyyy-MM-dd HH:mm:ss是
paymentTimeString2支付时间 格式yyyy-MM-dd HH:mm:ss是
invoiceTimeString2ETC发票开票时间 格式yyyy-MM-dd HH:mm:ss否
goodsReceiptDateTimeString2计划收货时间 格式yyyy-MM-dd HH:mm:ss否
despatchActualDateTimeString2计划发货时间 格式yyyy-MM-dd HH:mm:ss否
consignorString2发货人方名称是
consignorIdString2发货方统一社会信用代码或个人证件号是
consignorImgString2发货方统一社会信用代码或个人证件号照片否
linkPersonString2发货联系人是
linkPhoneString2发货联系人电话是
deliverLonString2发货经度是
deliverLatString2发货纬度是
deliverProvinceString2发货省是
deliverCityString2发货市是
deliverCountyString2发货区县是
placeOfLoadingString2发货地点是
loadingCountrySubdivisionCodeString2发货地点的国家行政区划代码是
consigneeString2收货方名称是
consigneeIdString2收货方统一社会信用代码或个人证件号码选填
consigneeTelString2收货方电话是
receivingLonString2收货经度是
receivingLatString2收货纬度是
receivingProvinceString2收货方省是
receivingCityString2收货方市是
receivingCountyString2收货方区县是
goodsReceiptPlaceString2收货地址是
unLoadingCountrySubdivisionCodeString2收货地点的国家行政区划代码是
imageUrlList<ApiReceiptDomain>2回单是
actualCarrierNameString2实际承运人名称是
actualCarrierIdString2实际承运人统一社会信用代码或证件号码是
actualCarrierBusinessLicenseString2实际承运人的道路运输经营许可证编号是
totalMonetaryAmountBigDecimal2货主运费金额是
waybillFreightAmountBigDecimal2司机运单运费金额是
totalDriverFreightBigDecimal2司机收款金额是

ApiReceiptDomain回单信息 ​

字段类型层级描述必填
imageTypeString3回单类型是
imageUrlString3回单地址是
uploadTimeString3回单时间 格式yyyy-MM-dd HH:mm:ss是

ApiContractBasicDomain 合同基本信息 ​

字段类型层级描述必填
contractBusinessNameString2合同业务名称是
contractTypeString2合同类型是
contractNumberString2合同编号是
partyANameString2甲方名称是
partyAIdString2甲方统一社会信用代码或个人证件号是
partyAAccountString2甲方收款账号否
partyABankNameString2甲方收款银行否
partyBNameString2乙方名称是
partyBIdString2乙方统一社会信用代码是
partyBReceiptNameString2乙方收款名称否
partyBAccountString2乙方收款账号否
partyBBankNameString2乙方银行否
contractAmountBigDecimal2合同金额是
agreedBusinessCompletionTimeString2约定业务完成时间 格式yyyy-MM-dd HH:mm:ss是
bankNameString2银行名称否
businessActualCompletionTimeString2业务实际完成时间 格式yyyy-MM-dd HH:mm:ss否
paymentAmountBigDecimal2付款金额否
contractSigningTimeString2合同签订时间否
contractedCarryingCapacityBigDecimal2合同签订承运量否
unitString2合同签订承运量单位：吨/立方米/件/车否
promisePayTimeString2约定甲方付款时间 格式yyyy-MM-dd HH:mm:ss否
serviceChargeString2收取服务费标准否
contractUrlString2合同文件（支持类型:pdf）是

ApiTrackDomain 轨迹信息 ​

字段类型层级描述必填
locationMethodString2定位方式是
locationTypeString2提货/运抵提货/运抵点必填,中间点不传
locationAddressString2定位地址否
locationProvinceString2定位省份否
locationCityString2定位市否
locationAreaString2定位区否
latBigDecimal2纬度是
lonBigDecimal2经度是
directionString2方向否
aglString2方向 原始数据否
speedString2速度否
highString2高度否
mileageString2里程否
locationTimeString2定位时间 格式yyyy-MM-dd HH:mm:ss是
descriptionString2描述否

ApiFinancialDomain 支付信息 ​

字段类型层级描述必填
statementTypeInteger2类型 1收入 2 支出是
financialTypeString2流水类型是
paymentMeansCodeString2付款方式代码是
paymentNameString2付款方名称是
paymentAccountString2付款方账号是
paymentBankNameString2付款方银行是
recipientString2收款方名称是
receiptAccountString2收款方账号是
receiptIdCardString2收款人身份证是
receiptBankNameString2收款方银行是
receiptBankCodeString2收款银行代码是
sequenceCodeString2系统流水号是
monetaryAmountBigDecimal2实际支付金额是
fuelAmountBigDecimal2油卡金额否
documentNumberString2银行流水号是
carrierString2实际承运人/托运人名称是
actualCarrierIdString2实际承运人/托运人统一社会信用代码或证件号码是
appointmentTimeString2合同约定付款时间 格式yyyy-MM-dd HH:mm:ss否
payTimeString2实际支付时间 格式yyyy-MM-dd HH:mm:ss是
replaceMeansCodeString2代收资金付款方式代码否
replacePaymentNameString2代收资金付款方名称否
replaceRecipientString2代收资金收款方名称否
replaceSequenceCodeString2代收资金流水号/序列号否
replaceMonetaryAmountBigDecimal2代收资金实际支付金额否
replacePayTimeString2代收资金实际支付时间 格式yyyy-MM-dd HH:mm:ss否
replaceReceiptIdCardString2代收资金收款方身份证否
replacePaymentIdCardString2代收资金付款方身份证否
receiptUrlString2银行回单（支持类型:jpg,jpeg,png,pdf,apng）是

ApiEtcInvoiceDomain ETC发票信息 ​

字段类型层级描述必填
invoiceCodeString2发票代码是
invoiceNumberString2发票号码否
amountBigDecimal2发票含税金额是
taxBigDecimal2税率是
invoiceTimeString2开票时间 格式yyyy-MM-dd HH:mm:ss是
startSiteString2高速入站口否
endSiteString2高速出站口否
sellerNameString2发票销售方名称是
sellerTaxpayerCodeString2销方税号是
invoiceUrlString2发票下载链接是
feeBigDecimal2交易金额是

请求参数示例 ​

json

{
  "bodyId": "ed3b21396f1e4730a4da7d566c964c8f",
  "contractBasicDomain": [
    {
      "contractBusinessName": "运输合同",
      "contractType": "OWNER",
      "contractNumber": "1231321312",
      "partyAName": "甲方公司",
      "partyAId": "91370200MA3TGY3Y7R",
      "partyAAccount": "1234567890123456789",
      "partyABankName": "中国银行",
      "partyBId": "91370200MA3TGY3Y7S",
      "partyBName": "乙方公司名称",
      "partyBReceiptName": "乙方收款名",
      "partyBBankName": "工商银行",
      "partyBAccount": "9876543210987654321",
      "contractAmount": 50000,
      "agreedBusinessCompletionTime": "2025-12-31 23:59:59",
      "bankName": "招商银行",
      "businessActualCompletionTime": "2025-12-30 23:59:59",
      "paymentAmount": 45000,
      "contractSigningTime": "2025-06-19 12:00:00",
      "contractedCarryingCapacity": 100,
      "unit": "吨",
      "promisePayTime": "2025-11-30 23:59:59",
      "serviceCharge": "按合同金额5%收取",
      "contractUrl": "http://example.com/contract/CT20250619001.pdf"
    }
  ],
  "etcInvoiceDomains": [
    {
      "invoiceCode": "ETC_INV_CODE_20250626",
      "invoiceNumber": "ETC_INV_NO_20250626001",
      "amount": 150,
      "tax": 9,
      "invoiceTime": "2025-06-26 09:30:00",
      "startSite": "上海浦东收费站",
      "endSite": "杭州德胜收费站",
      "sellerName": "高速公路电子收费有限公司",
      "sellerTaxpayerCode": "91370200MA3TGY3Y7R",
      "invoiceUrl": "http://example.com/etc/invoice/ETC_INV_NO_20250626001.pdf",
      "fee": 138
    }
  ],
  "financialDomains": [
    {
      "statementType": 2,
      "financialType": "OWNER",
      "paymentMeansCode": "BANK_TRANSFER",
      "paymentName": "付款方公司名称",
      "paymentAccount": "1234567890123456789",
      "paymentBankName": "中国银行",
      "recipient": "收款方公司名称",
      "receiptAccount": "9876543210987654321",
      "receiptIdCard": "91370200MA3TGY3Y7R",
      "receiptBankName": "工商银行",
      "receiptBankCode": "ICBC",
      "sequenceCode": "SEQ20250626001",
      "monetaryAmount": 5000,
      "fuelAmount": 500,
      "documentNumber": "DOC20250626001",
      "carrier": "实际承运人名称",
      "actualCarrierId": "91370200MA3TGY3Y7S",
      "appointmentTime": "2025-06-25 12:00:00",
      "payTime": "2025-06-26 10:00:00",
      "replaceMeansCode": "BANK_TRANSFER",
      "replacePaymentName": "代收付款方",
      "replaceRecipient": "代收录入方",
      "replaceSequenceCode": "REPLACE_SEQ20250626001",
      "replaceMonetaryAmount": 1000,
      "replacePayTime": "2025-06-26 11:00:00",
      "replaceReceiptIdCard": "91370200MA3TGY3Y7T",
      "replacePaymentIdCard": "91370200MA3TGY3Y7U",
      "receiptUrl": "http://example.com/receipt/REC20250626001.pdf"
    }
  ],
  "trackDomain": [
    {
      "locationMethod": "GPS",
      "locationType": "END",
      "locationAddress": "上海市浦东新区世纪大道100号",
      "locationProvince": "上海市",
      "locationCity": "上海市",
      "locationArea": "浦东新区",
      "lat": 31.2304,
      "lon": 121.4737,
      "direction": "东北",
      "agl": "90",
      "speed": "60 km/h",
      "high": "10 m",
      "mileage": "1000 km",
      "locationTime": "2025-06-19 20:41:00",
      "description": "测试定位数据"
    }
  ],
  "waybillArrivalDomain": {
    "shippingNoteNumber": "10250609552360666",
    "transportTypeCode": "ROAD_TRANSPORT",
    "businessTypeCode": "GANXIAN",
    "goodsArrangementTypeCode": "GOODS_TRANSPORT_TYPE_100",
    "departureTime": "2025-06-18 00:00:11",
    "goodsReceiptDateTime": "2025-06-18 00:00:00",
    "despatchActualDateTime": "2025-06-20 00:00:00",
    "arrivalTime": "2025-06-20 15:00:00",
    "paymentTime": "2025-06-19 14:00:00",
    "invoiceTime": "2025-06-19 16:00:00",
    "consignor": "测试企业",
    "consignorId": "91151512021511202",
    "consignorImg": "https://img.aaa.com/xQYxQ/TB2.Jpg",
    "linkPerson": "张三",
    "linkPhone": "13312345666",
    "deliverCity": "上海市",
    "deliverCounty": "浦东新区",
    "deliverLat": "31.230",
    "deliverLon": "121.473",
    "deliverProvince": "上海市",
    "placeOfLoading": "上海市浦东新区世纪大道100号",
    "loadingCountrySubdivisionCode": "310115",
    "consignee": "收货方公司名称",
    "consigneeId": "91370200MA3TGY3Y7S",
    "consigneeTel": "18887654321",
    "receivingCity": "北京市",
    "receivingCounty": "朝阳区",
    "receivingLat": "39.9042",
    "receivingLon": "116.4074",
    "receivingProvince": "北京市",
    "goodsReceiptPlace": "北京市朝阳区建国路88号",
    "unLoadingCountrySubdivisionCode": "110105",
    "imageUrl": [
      {
        "imageType": "RECEIPT",
        "imageUrl": "https://img.aaa.com/xQYxQ/TB2.Jpg",
        "uploadTime": "2021-05-05 12:00:00"
      }
    ],
    "actualCarrierBusinessLicense": "JYZX20250619001",
    "actualCarrierId": "91370200MA3TGY3Y7T",
    "actualCarrierName": "实际承运人公司",
    "totalMonetaryAmount": 5000,
    "totalDriverFreight": 4500,
    "waybillFreightAmount": 4500
  }
}

返回参数 ​

字段名类型层级描述
riskCheckStatusRiskCheckStatusEnum1核验/申诉状态
riskDetailsList<Object>1风控详情
riskTypeString2风控类型
riskCountint2风控数量
abnormalCountint2异常数量
riskItemDetailsList<Object>2风控项详情
rikeItemString3风控项
isAbnormalBoolean3是否异常
riskResultsList<String>3风控结果
riskWeightTypeRiskWeightTypeEnum3风险等级

返回参数示例 ​

json

{
  "code": 200,
  "msg": "业务处理成功",
  "data": {
    "riskCheckStatus": "FAILED",
    "riskCheckStatusText": "核验不通过",
    "riskDetails": [
      {
        "riskType": "运力异常",
        "riskCount": 7,
        "abnormalCount": 1,
        "riskItemDetails": [
          {
            "rikeItem": "行驶证有效期",
            "isAbnormal": true,
            "riskResults": [
              "车辆行驶证已过期"
            ],
            "riskWeightType": "MEDIUM",
            "riskWeightTypeText": "中风险"
          }
        ]
      },
      {
        "riskType": "运单异常",
        "riskCount": 17,
        "abnormalCount": 1,
        "riskItemDetails": [
          {
            "rikeItem": "超载",
            "isAbnormal": true,
            "riskResults": [
              "车辆超载，车辆核定载质量：10.00，运单吨重：200.00"
            ],
            "riskWeightType": "MEDIUM",
            "riskWeightTypeText": "中风险"
          }
        ]
      }
    ]
  },
  "total": null,
  "requestId": "95be5737-428020"
}

枚举 ​

核验/申诉状态（RiskCheckStatusEnum）：

NameMessage
WAIT核验中
PASS核验通过
FAILED核验不通过
APPROVED申诉通过
REJECTED申诉驳回
PROGRESS申诉中
NONE无需申诉

风险等级 （RiskWeightTypeEnum）：

NameMessage
HIGH高风险
MEDIUM中风险
LOW低风险