运单 | 快货运Open Api

# 开单

前置说明：调开单接口时，前置基础资料信息必须已通过接口导入，司机必须已经审核通过

接口名称：/transport/bill/add

请求参数

序号	层级	英文名称	中文名称	类型	长度	必填	说明
1	1	transportBillTime	开单时间	Long		否	单位：毫秒填写，开单时间<创建时间不填，开单时间默认等于创建时间，
2	1	loadingDateTimestamp	装货时间	Long		否	单位：毫秒填写，开单时间<装货时间<创建时间填写后运单状态跳转为已装货
3	1	unloadingDateTimestamp	卸货时间	Long		否	单位：毫秒填写，开单时间<装货时间<卸货时间<创建时间填写后运单状态跳转为已卸货
4	1	projectName	项目名称	String	40	否
5	1	routeName	线路名称	String	40	否	不填将收发货城市作为线路名称
6	1	shipperTransportBillNumber	客户单号	String	40	否	不填创建后将运单号填为客户单号
7	1	transportBusinessType	业务类型	Integer	10	是	枚举 1002996 干线普获运输 1003997 城市配送 1003998 农村配送 1002998 集装箱运输 1003999 其他
8	1	insuranceCompany	保险公司	String	32	否	必须同时存在保险公司需传输编号（详见代码集）
9	1	policyNumber	保险单号	String	64	否
10	1	remark	备注	String	20	否
11	1	shipperInfoDTO					托运方信息（自营平台和撮合平台模式默认为企业）运费单位：分
12	2	payType	支付方式	Integer	3	是	托运方的支付方式（仅自营模式可修改）枚举 0:现付，1:到付，2:月结，3:季度结，4:到付月结
13	2	shipperName	托运方名称	String	32	是
14	2	shipperPhone	托运方电话	String	16	是
15	2	shipperIdCard	托运方证件号码	String	32	是	自营模式下，需要先去基础资料部分维护客户资料
16	2	shipperTransportCost	托运方运费	Long	20	否	运费单位：分
17	1	addressInfoDTO
18	2	senderName	发货方名称	String	32	是
19	2	senderPhone	发货方电话	String	16	是
20	2	senderProvince	发货省	String	10	是	省、直辖市行政区划码(详见代码集)
21	2	senderCity	发货市	String	10	是	市、直辖市城区/郊县(如：500100-重庆城区，500200-重庆郊县)、省直辖县行政区划码(如：469025-白沙黎族自治县)
22	2	senderDistrict	发货区	String	10	是	区、市辖县行政区划码，如果没有区，不填
23	2	senderLocation	发货方详细地址	String	64	是
24	2	senderLng	发货地址经度	BigDecimal	10,6	否	电子围栏开启必传
25	2	senderLat	发货地址维度	BigDecimal	10,6	否
26	2	receiverName	收货方名称	String	32	是
27	2	receiverPhone	收货方电话	String	16	是
28	2	receiverProvince	收货省	String	10	是	省、直辖市行政区划码(详见代码集)
29	2	receiverCity	收货市	String	10	是	市、直辖市城区/郊县(如：500100-重庆城区，500200-重庆郊县)、省直辖县行政区划码(如：469025-白沙黎族自治县)
30	2	receiverDistrict	收货区	String	10	是	区、市辖县行政区划码，如果没有区，不填
31	2	receiverLocation	收货方详细地址	String	64	是
32	2	receiverLng	收货地址经度	BigDecimal	10,6	否	电子围栏开启必传（4 位整数，6 位小数）
33	2	receiverLat	收货地址维度	BigDecimal	10,6	否
34	1	goodsInfoDTO
35	2	goodsName	货物名称	String	50	是
36	2	goodsType	货物类型	String	20	是	详见代码集
37	2	weight	货物重量	Long	20	是	单位：克
38	2	volume	货物体积	Long	20	否	单位：立方分米
39	2	number	货物件数	Long	20	否	单位：件
40	1	carrierInfoDTO
41	2	carrierName	承运人名称	String	20	否	如果想传入承运人信息，则姓名必填，电话和证件号2选1
42	2	carrierPhone	承运人电话	String	20	否	承运人电话和证件号可2选1。如果2者都传，会按照身份证号进行校验
43	2	carrierIdCard	承运人证件号	String	20	否	承运人电话和证件号可2选1。如果2者都传，会按照身份证号进行校验
44	2	driverName	司机姓名	String	20	否	如果想传入司机信息，则姓名必填，电话和证件号2选1
45	2	driverPhone	司机电话	String	20	否	司机电话和证件号可2选1。如果2者都传，会按照身份证号进行校验
46	2	driverIdCard	司机证件号	String	20	否	司机电话和证件号可2选1。如果2者都传，会按照身份证号进行校验
47	2	carLicensePlate	车牌号码	String	16	否
48	2	carrierTransportCost	承运人运费	Long	20	是	暂无填 0 ，单位：分承运人运费=油卡付+预付+到付+回单付+信息费
49	2	oilCardPayment	油卡付	Long	20	是	暂无填 0，单位：分（撮合平台模式无油卡付）
50	2	prePayment	预付	Long	20	是	暂无填 0，单位：分
51	2	arrivePayment	到付	Long	20	是	暂无填 0，单位：分
52	2	receiptPayment	回单付	Long	20	是	暂无填 0，单位：分
53	2	informationPayment	信息费	Long	20	是	暂无填 0，单位：分
54	2	bankAccountName	银行开户名	String	20	否	承运人=司机，收款账户不会校验承运人不等于司机，收款账户必须为承运人本人同时存在
55	2	bankCardNumber	银行卡号	String	20	否
56	2	bankDeposit	开户银行	String	64	否
57	2	payeeIdCard	收款人的证件号	String	20	否
58	2	bankCardNumberType	账户类型 1-银行账户 2-在线账户 4-支付宝 5-微信 6-第三方 7-其他	String	20	否
59	2	informationPaymentBankAccountName	银行开户名（信息费）	String	20	否
60	2	informationPaymentBankCardNumber	银行卡号（信息费）	String	20	否
61	2	informationPaymentBankDeposit	开户银行（信息费）	String	64	否
62	2	informationPaymentPayeeIdCard	收款人的证件号（信息费）	String	20	否
63	2	informationPaymentBankCardNumberType	账户类型（信息费） 1-银行账户 2-在线账户 4-支付宝 5-微信 6-第三方 7-其他	String	20	否
64	1	deviceNumber	设备号	String	20	否
65	1	deviceType	设备类型	Integer	20	否	设备类型 10：小黑卡，20：中交兴路，30：小黑卡K5，40：G7，60：小黑卡K6，99：其他

返回参数

序号	英文名称	中文名称	说明
1	transportBillNumber	运单号

mock 数据示例

{
  "addressInfoDTO": {
    "receiverCity": "string",
    "receiverCityName": "string",
    "receiverDistrict": "string",
    "receiverDistrictName": "string",
    "receiverIdCard": "string",
    "receiverLat": 0,
    "receiverLng": 0,
    "receiverLocation": "string",
    "receiverName": "string",
    "receiverPhone": "string",
    "receiverProvince": "string",
    "receiverProvinceName": "string",
    "senderCity": "string",
    "senderCityName": "string",
    "senderDistrict": "string",
    "senderDistrictName": "string",
    "senderLat": 0,
    "senderLng": 0,
    "senderLocation": "string",
    "senderName": "string",
    "senderPhone": "string",
    "senderProvince": "string",
    "senderProvinceName": "string"
  },
  "carrierInfoDTO": {
    "arrivePayment": 0,
    "bankAccountName": "string",
    "bankCardNumber": "string",
    "bankDeposit": "string",
    "carLicensePlate": "string",
    "carrierIdCard": "string",
    "carrierName": "string",
    "carrierPhone": "string",
    "carrierTransportCost": 0,
    "driverIdCard": "string",
    "driverName": "string",
    "driverPhone": "string",
    "oilCardPayment": 0,
    "payeeIdCard": "string",
    "paymentWay": 0,
    "prePayment": 0,
    "receiptPayment": 0,
    "informationPayment": 0,
    "bankCardNumberType": 1,
    "informationPaymentBankAccountName": "string",
    "informationPaymentBankCardNumber": "string",
    "informationPaymentBankDeposit": "string",
    "informationPaymentPayeeIdCard": "string",
    "informationPaymentBankCardNumberType": 1
  },
  "goodsInfoDTO": {
    "goodsName": "string",
    "goodsType": "string",
    "number": 0,
    "volume": 0,
    "weight": 0
  },
  "insuranceCompany": "string",
  "loadingDateTimestamp": 0,
  "policyNumber": "string",
  "projectName": "string",
  "routeName": "string",
  "shipperInfoDTO": {
    "payType": 0,
    "shipperName": "string",
    "shipperPhone": "string",
    "shipperIdCard": "string",
    "shipperTransportCost": 0
  },
  "shipperTransportBillNumber": "string",
  "transportBillTime": 0,
  "unloadingDateTimestamp": 0,
  "remark": "remark"
}

# 编辑运单

前置说明：运单状态为【待指派】【已指派】【已装货】【已卸货】才可以进行编辑

接口名称：/transport/bill/update

请求参数

序号	层级	英文名称	中文名称	类型	长度	必填	说明
1	1	transportBillNumber	运单号	String		是
2	1	transportBillTime	开单时间	Long		否	单位：毫秒填写，开单时间<创建时间不填，开单时间默认等于创建时间，
3	1	loadingDateTimestamp	装货时间	Long		否	单位：毫秒填写，开单时间<装货时间<创建时间填写后运单状态跳转为已装货
4	1	unloadingDateTimestamp	卸货时间	Long		否	单位：毫秒填写，开单时间<装货时间<卸货时间<创建时间填写后运单状态跳转为已卸货
5	1	projectName	项目名称	String	40	否
6	1	routeName	线路名称	String	40	否	不填将收发货城市作为线路名称
7	1	shipperTransportBillNumber	客户单号	String	40	否	不填创建后将运单号填为客户单号
8	1	transportBusinessType	业务类型	Integer	10	是	枚举 1002996 干线普获运输 1003997 城市配送 1003998 农村配送 1002998 集装箱运输 1003999 其他
9	1	remark	备注	String	20	否
10	1	shipperInfoDTO					托运方信息（仅自营模式可修改）运费单位：分
11	2	payType	支付方式	Integer	3	是	托运方的支付方式（自营平台，撮合平台模式，默认现付）枚举 0:现付，1:到付，2:月结，3:季度结，4:到付月结
12	2	shipperName	托运方名称	String	32	是
13	2	shipperPhone	托运方电话	String	16	是
14	2	shipperIdCard	托运方证件号码	String	32	是	托运方信息（自营平台和撮合平台模式默认为企业）自营模式下，需要先去基础资料部分维护客户资料
15	2	shipperTransportCost	托运方运费	Long	20	否	运费单位：分
16	1	addressInfoDTO
17	2	senderName	发货方名称	String	32	是
18	2	senderPhone	发货方电话	String	16	是
19	2	senderProvince	发货省	String	10	是	省、直辖市行政区划码(详见代码集)
20	2	senderCity	发货市	String	10	是	市、直辖市城区/郊县(如：500100-重庆城区，500200-重庆郊县)、省直辖县行政区划码(如：469025-白沙黎族自治县)
21	2	senderDistrict	发货区	String	10	是	区、市辖县行政区划码，如果没有区，不填
22	2	senderLocation	发货方详细地址	String	64	是
23	2	senderLng	发货地址经度	BigDecimal	10,6	否	电子围栏开启必传
24	2	senderLat	发货地址维度	BigDecimal	10,6	否
25	2	receiverName	收货方名称	String	32	是
26	2	receiverPhone	收货方电话	String	16	否
27	2	receiverProvince	收货省	String	10	是	省、直辖市行政区划码(详见代码集)
28	2	receiverCity	收货市	String	10	是	市、直辖市城区/郊县(如：500100-重庆城区，500200-重庆郊县)、省直辖县行政区划码(如：469025-白沙黎族自治县)
29	2	receiverDistrict	收货区	String	10	是	区、市辖县行政区划码，如果没有区，不填
30	2	receiverLocation	收货方详细地址	String	64	是
31	2	receiverLng	收货地址经度	BigDecimal	10,6	否	电子围栏开启必传（4 位整数，6 位小数）
32	2	receiverLat	收货地址维度	BigDecimal	10,6	否
33	1	goodsInfoDTO
34	2	goodsName	货物名称	String	50	是
35	2	goodsType	货物类型	String	20	是	详见代码集
36	2	weight	货物重量	Long	20	是	单位：克
37	2	volume	货物体积	Long	20	否	单位：立方分米
38	2	number	货物件数	Long	20	否	单位：件
39	1	loadingUnloadingInfo
40	2	loadStatusGoodsWeight	装货重量	Long	20	条件必传	传入装货信息时,装货重量必传
41	2	loadStatusGoodsVolume	装货体积	Long	20	否
42	2	loadStatusGoodsNumber	装货件数	Long	20	否
43	2	loadStatusOperateUrlList	装货图片	List<String>	9	否	建议大小不超过 5M，不超过 9 张
44	2	unloadStatusGoodsWeight	卸货重量	Long	50	条件必传	传入卸货信息时,卸货重量必传
45	2	unloadStatusGoodsVolume	卸货体积	Long	20	否
46	2	unloadStatusGoodsNumber	卸货件数	Long	20	否
47	2	unloadStatusOperateUrlList	卸货图片	List<String>	20	否	建议大小不超过 5M，不超过 9 张
48	1	carrierInfoDTO
49	2	carrierName	承运人名称	String	20	否	如果想传入承运人信息，则姓名必填，电话和证件号2选1
50	2	carrierPhone	承运人电话	String	20	否	承运人电话和证件号可2选1。如果2者都传，会按照身份证号进行校验
51	2	carrierIdCard	承运人证件号	String	20	否	承运人电话和证件号可2选1。如果2者都传，会按照身份证号进行校验
52	2	driverName	司机姓名	String	20	否	如果想传入司机信息，则姓名必填，电话和证件号2选1
53	2	driverPhone	司机电话	String	20	否	司机电话和证件号可2选1。如果2者都传，会按照身份证号进行校验
54	2	driverIdCard	司机证件号	String	20	否	司机电话和证件号可2选1。如果2者都传，会按照身份证号进行校验
55	2	carLicensePlate	车牌号码	String	16	否
56	2	carrierTransportCost	承运人运费	Long	20	是	暂无填 0 ，单位：分承运人运费=油卡付+预付+到付+回单付+信息费
57	2	oilCardPayment	油卡付	Long	20	是	暂无填 0，单位：分（撮合平台模式无油卡付）
58	2	prePayment	预付	Long	20	是	暂无填 0，单位：分
59	2	arrivePayment	到付	Long	20	是	暂无填 0，单位：分
60	2	receiptPayment	回单付	Long	20	是	暂无填 0，单位：分
61	2	informationPayment	信息费	Long	20	是	暂无填 0，单位：分
62	2	bankAccountName	银行开户名	String	20	否	承运人=司机，收款账户不会校验承运人不等于司机，收款账户必须为承运人本人同时存在支付过任意一笔后，不能修改
63	2	bankCardNumber	银行卡号	String	20	否
64	2	bankDeposit	开户银行	String	64	否
65	2	payeeIdCard	收款人的证件号	String	20	否
66	2	bankCardNumberType	账户类型 1-银行账户 2-在线账户 4-支付宝 5-微信 6-第三方 7-其他	String	20	否
67	2	informationPaymentBankAccountName	银行开户名（信息费）	String	20	否
68	2	informationPaymentBankCardNumber	银行卡号（信息费）	String	20	否	不填会清空信息费收款人
69	2	informationPaymentBankDeposit	开户银行（信息费）	String	64	否
70	2	informationPaymentPayeeIdCard	收款人的证件号（信息费）	String	20	否
71	2	informationPaymentBankCardNumberType	账户类型（信息费） 1-银行账户 2-在线账户 4-支付宝 5-微信 6-第三方 7-其他	String	20	否
72	1	deviceType	设备类型	Integer	20	否	10：小黑卡，20：中交兴路，30：小黑卡K5，40：G7，60：小黑卡K6，99：其他

返回参数

序号	英文名称	中文名称	说明
Boolean	data	是否成功

mock 数据示例

{
  "addressInfoDTO": {
    "receiverCity": "string",
    "receiverCityName": "string",
    "receiverDistrict": "string",
    "receiverDistrictName": "string",
    "receiverIdCard": "string",
    "receiverLat": 0,
    "receiverLng": 0,
    "receiverLocation": "string",
    "receiverName": "string",
    "receiverPhone": "string",
    "receiverProvince": "string",
    "receiverProvinceName": "string",
    "senderCity": "string",
    "senderCityName": "string",
    "senderDistrict": "string",
    "senderDistrictName": "string",
    "senderIdCard": "string",
    "senderLat": 0,
    "senderLng": 0,
    "senderLocation": "string",
    "senderName": "string",
    "senderPhone": "string",
    "senderProvince": "string",
    "senderProvinceName": "string"
  },
  "carrierInfoDTO": {
    "arrivePayment": 0,
    "bankAccountName": "string",
    "bankCardNumber": "string",
    "bankDeposit": "string",
    "carLicensePlate": "string",
    "carrierIdCard": "string",
    "carrierName": "string",
    "carrierPhone": "string",
    "carrierTransportCost": 0,
    "driverIdCard": "string",
    "driverName": "string",
    "driverPhone": "string",
    "oilCardPayment": 0,
    "payeeIdCard": "string",
    "paymentWay": 0,
    "prePayment": 0,
    "receiptPayment": 0,
    "informationPayment": 0,
    "bankCardNumberType": 1,
    "informationPaymentBankAccountName": "string",
    "informationPaymentBankCardNumber": "string",
    "informationPaymentBankDeposit": "string",
    "informationPaymentPayeeIdCard": "string",
    "informationPaymentBankCardNumberType": 1
  },
  "goodsInfoDTO": {
    "goodsName": "string",
    "goodsType": "string",
    "number": 0,
    "volume": 0,
    "weight": 0,
    "weightUnit": 0
  },
  "loadingUnloadingInfo": {
    "loadStatusGoodsNumber": 0,
    "loadStatusGoodsVolume": 0,
    "loadStatusGoodsWeight": 0,
    "loadStatusOperateUrlList": [""],
    "unloadStatusGoodsNumber": 0,
    "unloadStatusGoodsVolume": 0,
    "unloadStatusGoodsWeight": 0,
    "unloadStatusOperateUrlList": [""]
  },
  "insuranceCompany": "string",
  "loadingDateTimestamp": 0,
  "policyNumber": "string",
  "projectName": "string",
  "routeName": "string",
  "shipperInfoDTO": {
    "payType": 0,
    "shipperName": "string",
    "shipperPhone": "string",
    "shipperIdCard": "string",
    "shipperTransportCost": 0
  },
  "shipperTransportBillNumber": "string",
  "transportBillTime": 0,
  "unloadingDateTimestamp": 0,
  "remark": "remark"
}

# 运单关闭

前置说明：运单状态为【待指派】【已指派】【已装货】【已卸货】才可以进行关闭

接口名称：/transport/bill/close

请求参数

序号	层级	英文名称	中文名称	类型	长度	必填	说明
1	1	transportBillNumber	运单号	String	20	是

返回参数

类型	名称	备注
Boolean	data	是否成功

mock 数据示例 { "code": "00000", "data": "true", "message": "请求成功" }

# 签收

前置说明：仅已卸货状态可以进行签收

接口名称：/transport/bill/sign

请求参数

序号	层级	英文名称	中文名称	类型	长度	必填	说明
1	1	transportBillNumber	运单号	String	20	是
2	1	loadStatusGoodsWeight	装货重量	Long	20	是
3	1	loadStatusGoodsVolume	装货体积	Long	20	否
4	1	loadStatusGoodsNumber	装货件数	Long	20	否
5	1	loadStatusOperateUrlList	装货图片	array[String]	1000	否	建议大小不超过 5M，不超过 9 张
6	1	unloadStatusGoodsWeight	卸货重量	Long	20	是
7	1	unloadStatusGoodsVolume	卸货体积	Long	20	否
8	1	unloadStatusGoodsNumber	卸货件数	Long	20	否
9	1	unloadStatusOperateUrlList	卸货图片	array[String]	1000	否	建议大小不超过 5M，不超过 9 张
10	1	signDateTime	签收时间	Long		是	签收时间晚于卸货时间晚于装货时间

返回参数

类型	名称	备注
Boolean	data	是否成功

mock 数据示例

{
  "transportBillNumber": "string",
  "loadStatusGoodsNumber": 0,
  "loadStatusGoodsTransportCost": 0,
  "loadStatusGoodsVolume": 0,
  "loadStatusGoodsWeight": 0,
  "loadStatusOperateUrlList": ["string"],

  "unloadStatusGoodsNumber": 0,
  "unloadStatusGoodsTransportCost": 0,
  "unloadStatusGoodsVolume": 0,
  "unloadStatusGoodsWeight": 0,
  "unloadStatusOperateUrlList": ["string"],

  "signDateTime": 0
}

# 撤销签收

接口名称：/transport/bill/cancelSign

请求参数：

序号	层级	英文名称	中文名称	参数类型	是否必填	说明
1	1	transportBillNumber	运单号	String	是

mock数据示例

{
  "transportBillNumber":"202403050004000001"
}

返回参数：

序号	类型	说明
1	Boolean	True-撤销成功 False-撤销失败

mock数据示例

{
  "code":"0000",
  "data":true,
  "message":"请求成功"
}

# 修改运费

前置说明：运单状态为已签收才可以调修改运费接口

接口名称：/transport/bill/cost/update

请求参数

序号	层级	英文名称	中文名称	类型	长度	必填	说明
1	1	transportBillNumber	运单号	String	20	是
2	1	carrierName	承运人名称	String	20	是	支付任意一笔后不可修改承运人
3	1	carrierPhone	承运人电话	String	20	是
4	1	carrierIdCard	承运人证件号码	String	20	是
5	1	carrierTransportCost	承运人运费	Long	20	是	承运人运费=油卡付+预付+到付+回单付
6	1	oilCardPayment	油卡付	Long	20	是	支付后不可修改，没有值传 0。撮合平台无此字段
7	1	prePayment	预付	Long	20	是	支付后不可修改，没有值传 0
8	1	arrivePayment	到付	Long	20	是	支付后不可修改，没有值传 0
9	1	receiptPayment	回单付	Long	20	是	支付后不可修改，没有值传 0
10	1	informationPayment	信息费	Long	20	是	支付后不可修改，没有值传 0
11	1	bankAccountName	银行开户名	String	20	是
12	1	bankCardNumber	银行卡号	String	20	是
13	1	bankDeposit	开户银行	String	64	是
14	1	payeeIdCard	收款人证件号码	String	20	是
15	1	informationPaymentBankAccountName	银行开户名（信息费）	String	20	否
16	1	informationPaymentBankCardNumber	银行卡号（信息费）	String	20	否
17	1	informationPaymentBankDeposit	开户银行（信息费）	String	64	否
18	1	informationPaymentPayeeIdCard	收款人的证件号（信息费）	String	20	否

返回参数

类型	名称	备注
Boolean	data	是否成功

mock 数据示例

{
  "arrivePayment": 0,
  "bankAccountName": "string",
  "bankCardNumber": "string",
  "bankDeposit": "string",
  "carrierIdCard": "string",
  "carrierName": "string",
  "carrierPhone": "string",
  "carrierTransportCost": 0,
  "oilCardPayment": 0,
  "payeeIdCard": "string",
  "prePayment": 0,
  "receiptPayment": 0,
  "transportBillId": 0,
  "transportBillNumber": "string"
}

# 查询运单-运单维度

接口名称：/transport/bill/search

请求参数

序号	层级	英文名称	中文名称	类型	长度	必填
1	1	transportBillNumberList	运单号	[String]	20	是

返回参数

序号	层级	英文名称	中文名称	备注
1	1	transportBillNumber	运单号
2	1	transportBillTime	开单时间
3	1	loadingDateTimestamp	装货时间
4	1	unloadingDateTimestamp	卸货时间
5	1	projectName	项目名称
6	1	routeName	线路名称
7	1	shipperTransportBillNumber	客户单号
8	1	transportBillStatus	运单状态	运单状态:待指派司机 20 待装货 30 待卸货 40 待签收 50 待关闭 60
9	1	transportBusinessType	业务类型
10	1	serviceCostRate	服务费率
11	1	shipperInfoDTO	托运方信息
12	2	shipperName	托运方名称
13	2	shipperPhone	托运方电话
14	2	shipperIdCard	证件号码
52	2	serviceCost	服务费	仅自营平台和撮合平台
15	1	addressInfoDTO	地址信息
16	2	senderName	发货方名称
17	2	senderPhone	发货方电话
18	2	senderProvince	发货省
19	2	senderCity	发货市
20	2	senderDistrict	发货区
21	2	senderLocation	发货方详细地址
22	2	senderLng	发货地址经度
23	2	senderLat	发货地址维度
24	2	receiverName	收货方名称
25	2	receiverPhone	收货方电话
26	2	receiverProvince	收货省
27	2	receiverCity	收货市
28	2	receiverDistrict	收货区
29	2	receiverLocation	收货方详细地址
30	2	receiverLng	收货地址经度
31	2	receiverLat	收货地址维度
32	1	goodsInfoDTO	货物信息
33	2	goodsName	货物名称
34	2	goodsType	货物类型
35	2	weight	货物重量
36	2	volume	货物体积
37	2	number	货物件数
38	1	carrierInfoDTO	承运人相关信息
39	2	carrierName	承运人名称	仅自营和自营平台
40	2	carrierPhone	承运人电话
41	2	carrierIdCard	承运人证件
42	2	driverName	司机姓名
43	2	driverPhone	司机电话
44	2	driverIdCard	司机证件
45	2	carLicensePlate	车牌号码
46	2	deviceNumber	设备号
47	2	carrierTransportCost	承运人运费
48	2	oilCardPayment	油卡付
49	2	prePayment	预付
50	2	arrivePayment	到付
51	2	receiptPayment	回单付
52	2	informationPayment	信息费
53	2	bankAccountName	银行开户名
54	2	bankCardNumber	银行卡号
55	2	bankDeposit	开户银行
56	2	payeeIdCard	收款人身份证
57	2	informationPaymentBankAccountName	银行开户名（信息费）
58	2	informationPaymentBankCardNumber	银行卡号（信息费）
59	2	informationPaymentBankDeposit	开户银行（信息费）
60	2	informationPaymentPayeeIdCard	收款人身份证（信息费）
61	1	riskStatus	开票风险状态	-1未上报 0-风控审核中 1-要素完整 2-要素异常 3-要素缺失（未自证） 4-已申诉 5-上报失败 6-要素缺失
62	1	riskStatusText	开票风险状态说明
63	1	riskErrorMsgJson	风控异常信息
64	1	riskErrorJson	风控异常信息-Json格式
65	1	payStatus	支付状态	"未支付"或"支付成功"。未支付包含：从未支付、部分支付、支付中、支付失败。
66	1	payDateTime	支付时间
67	1	discardStatus	运单是否作废	0未作废 1已作废
68	1	closeStatus	运单是否关闭	0未关闭 1已关闭
69	1	shipperInvoiceProofNumber	托运方开票凭证号

mock 数据示例

{
  "transportBillNumberList": ["string"]
}

# 查询运单-时间维度

接口名称：/transport/bill/searchByTime

请求参数

序号	层级	英文名称	中文名称	类型	长度	是否必填	说明
1	1	createStartTime	开始时间	Long	20	是
2	1	createEndTime	结束时间	Long	20	是	最大支持查询时间跨度为30天的数据
3	1	pageNum	页码	Integer	20	是
4	1	pageSize	页容量	Integer	20	否	不传值默认100,最大500

mock数据示例

{
    "createStartTime":1698768000000,
    "createEndTime":1701359999999,
    "pageNum":1,
    "pageSize":50
}

返回参数

序号	层级	类型	名称	说明
1	1	String	code	结果码
2	1	PageInfo	data	运单号分页数据
3	2	[String]	records	运单号列表
4	1	String	message	返回文本

mock数据示例

{
  "code": "00000",
  "data": {
    "records": [
      "202311090004000001",
      "202311090004000003",
      "202311100004000007",
      "202311100004000008",
      "202311100004000009"
    ],
    "total": 0,
    "size": 50,
    "pageSize": 50,
    "current": 1,
    "pageNum": 1,
    "orders": [],
    "optimizeCountSql": true,
    "hitCount": false,
    "countId": null,
    "maxLimit": null,
    "searchCount": true,
    "pages": 0
  },
  "message": "请求成功",
  "traceId": "a0c2f7aa6f8f453cb6057f0babad3a60"
}

# 上传轨迹接口

接口名称：/transport/bill/truck/track/upload

请求参数

序号	层级	英文名称	中文名称	类型	长度	必填	说明
1	1	transportBillNumber	运单号	String	20	是
2	1	truckTrackDTO					最大支持 500 个点
3	2	locateTime	轨迹点定位时间	Long		是	时间戳(毫秒)，介于开单时间和签收时间之间，未签收时为开单时间+30 天。上传的轨迹和系统轨迹合并
4	2	longitude	经度	String	20	是	GCJ-02
5	2	latitude	纬度	String	20	是	GCJ-02

返回参数

类型	名称	备注
Boolean	data	是否成功

mock 数据示例

{
  "transportBillNumber": "string",
  "truckTrackDTO": [
    {
      "latitude": "string",
      "locateTime": 0,
      "longitude": "string"
    }
  ]
}

# 风控结果回调通知

1.请求头会携带sign参数，用于鉴权

serviceName : riskStatusNotify

接口名称：由接入方提供回调地址

请求参数

序号	层级	英文名称	中文名称	类型	长度	是否必填	说明
1	1	serviceName	服务名	String		是
2	1	apiId	接入appId	String		是
4	1	transportBillNumber	运单号	String	20	是	长度20
5	1	riskStatus	风控状态	Integer	5	是	风控状态: 0-风控审核中 1-要素完整 2-要素异常 3-要素缺失（未自证） 4-已申诉 5-上报失败 6-要素缺失 7-未开通风控服务 8-要素缺失（申诉中） 9-待地方监管审核
6	1	riskStatusText	风控状态文本	String	64	是	风控状态: 0-风控审核中 1-要素完整 2-要素异常 3-要素缺失（未自证） 4-已申诉 5-上报失败 6-要素缺失 7-未开通风控服务 8-要素缺失（申诉中） 9-待地方监管审核
7	1	riskErrorMsgJson	风控报错信息	String	1024	否	拒绝原因

mock 数据示例

{
    "apiId":"9fa5c1643b454f7ab2e026082d610e6b",
    "results":[
        {
            "transportBillNumber":"202208030041000894",
            "riskStatus":1,
            "riskStatusText":"要素完整",
            "riskErrorMsgJson":"{\"antiFraudDetails\":[],\"executeTime\":1721097219877,\"resultCode\":\"OK\",\"resultMsg\":\"成功\",\"status\":3,\"statusDescription\":\"要素完整\",\"waybillNo\":\"202407160004000002\"}"
        }
    ],
    "serviceName":"appealStatusNotify"
}

# 异常运单申诉接口

接口名称：/transport/bill/appeal

请求参数

序号	层级	英文名称	中文名称	类型	长度	必填	说明
1	1	transportBillNumber	运单号	String	20	是
2	1	loadingUrls	装货凭证	array[String]	1000	是	建议大小不超过 5M，不超过 9张
3	1	dischargeUrls	卸货凭证	array[String]	1000	是	建议大小不超过 5M，不超过 9张
3	1	otherUrls	其它凭证	array[String]	1000	否	建议大小不超过 5M，不超过 9张
5	1	remark	说明	String	200	否

返回参数

类型	名称	备注
Boolean	data	是否成功

{
  "transportBillNumber": "string",
  "loadingUrls": ["string"],
  "dischargeUrls": ["string"],
  "otherUrls": ["string"],
  "remark": "string"
}

# 异常运单(不可开票)申诉接口

接口名称：/transport/bill/nonInvoicableAppeal

请求参数

序号	层级	英文名称	中文名称	类型	长度	必填	说明
1	1	transportBillNumber	运单号	String	20	是
2	1	loadingUrls	装货凭证	List<String>	1000	是	建议大小不超过 5M，不超过 9张
3	1	dischargeUrls	卸货凭证	List<String>	1000	是	建议大小不超过 5M，不超过 9张
3	1	otherUrls	其它凭证	List<String>	1000	否	建议大小不超过 5M，不超过 9张
5	1	remark	说明	String	200	否

mock数据示例

{
  "transportBillNumber": "string",
  "loadingUrls": ["string"],
  "dischargeUrls": ["string"],
  "otherUrls": ["string"],
  "remark": "string"
}

返回参数

类型	名称	备注
Boolean	data	是否成功

# 申诉结果回调通知

1.请求头会携带sign参数，用于鉴权

serviceName : appealStatusNotify

接口名称：由接入方提供回调地址

请求参数

序号	层级	英文名称	中文名称	类型	长度	是否必填	说明
1	1	serviceName	服务名	String		是
2	1	apiId	接入appId	String		是
4	1	transportBillNumber	运单号	String	20	是	长度20
5	1	status	申诉状态	Integer	5	是	申诉状态: 1-待平台审核 2-已通过 3-已拒绝 5-待监管审核 6-自动删除
6	1	statusText	申诉状态文本	String	64	是	申诉状态: 1-待平台审核 2-已通过 3-已拒绝 5-待监管审核 6-自动删除
7	1	rejectReason	拒绝原因	String	128	否	拒绝原因

mock 数据示例

{
    "apiId":"9fa5c1643b454f7ab2e026082d610e6b",
    "results":[
        {
            "transportBillNumber":"202208030041000894",
            "status":2,
            "statusText":"已通过",
            "rejectReason":null
        }
    ],
    "serviceName":"appealStatusNotify"
}

# 查询申诉结果接口

接口名称：/transport/bill/appeal/search

请求参数

序号	层级	英文名称	中文名称	类型	长度	必填	说明
1	1	transportBillNumber	运单号	String	20	是

返回参数

序号	层级	英文名称	中文名称	备注
1	1	transportBillNumber	运单号
2	1	status	申诉状态	申诉状态 0-未申诉 1-待审核 2-已通过 3-已拒绝
3	1	rejectReason	拒绝原因

{
  "transportBillNumber": "string",
  "status": 1
}

# 批量作废

接口名称：/transport/bill/close/batch

请求参数

序号	层级	英文名称	中文名称	类型	长度	必填	说明
1	1	transportBillNumberList	运单号列表	String	20	是

返回参数

类型	名称	备注
Boolean	data	是否成功

mock 数据示例

{
  "transportBillNumberList": ["string"]
}

# 省市区关系映射

接口名称：/transport/bill/getRegions

返回参数

序号	层级	英文名称	中文名称	备注
1	1	trafficCode	行政区划码（交通）
2	1	trafficName	行政区划名称（交通）
3	1	amapCode	行政区划码（高德）
4	1	amapName	行政区划名称（高德）
5	1	parentId	上级行政区划码（交通）	没有上级时，值为0
6	1	children		下级关系映射

mock数据示例

{
    "code": "00000",
    "data": [
        {
            "trafficCode": "110000",
            "trafficName": "北京市",
            "amapCode": "110000",
            "amapName": "北京市",
            "parentId": 0,
            "children": [
                {
                    "trafficCode": "110100",
                    "trafficName": "北京城区",
                    "amapCode": "110100",
                    "amapName": "北京城区",
                    "parentId": 110000,
                    "children": []
                }
            ]
        }
    ],
    "message": "请求成功",
    "traceId": "384428dd1f954e518833721ad351d0f6"
}

← 实名认证承运业务在线支付 →