文档中心
一、商家寄件下单接口 二、下单回调接口 三、商家寄件下单取消接口 四、商家寄件下单价格接口 五、快递信息推送接口 六、快递公司编码 七、业务类型参数表 八、费用类型(feeType)说明 九、商家寄件订单详情查询接口 十、电子面单复打接口 API调试工具

快递公司寄件接口

一、商家寄件下单接口

选择快递公司进行下单。

1.1 接口格式

提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。

1.2 请求地址

https://poll.kuaidi100.com/order/borderapi.do

请求参数:

参数名是否必填类型说明
methodstring业务类型(默认:bOrder)
keystring授权码,请到快递100页面申请企业版接口获取
signstring32位大写签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号。secret在企业管理后台获取
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param数据结构:

参数名是否必填类型说明
kuaidicomstring快递公司的编码,一律用小写字母,见《快递公司编码》
recManNamestring收件人姓名
recManMobilestring收件人的手机号,手机号和电话号二者其一必填
recManPrintAddrstring收件人所在完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园
sendManNamestring寄件人姓名
sendManMobilestring寄件人的手机号,手机号和电话号二者其一必填
sendManPrintAddrstring寄件人所在的完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10
callBackUrlstringcallBackUrl订单信息回调地址
cargostring物品名称,例:文件。当kuaidicom=jd,yuantong时,必填
paymentstring支付方式,SHIPPER: 寄付(默认)。不支持到付
serviceTypestring业务类型,默认为标准快递,各快递公司业务类型对照参考:七、业务类型参数表
weightstring物品总重量KG,不需带单位,例:1.5
remarkstring备注
saltstring签名用随机字符串,用于验证签名sign。salt值不为null时,推送数据将包含该加密签名,加密方式:md5(param+salt)。注意: salt值为空串时,推送的数据也会包含sign,此时可忽略sign的校验。
dayTypestring预约日期,例如:今天/明天/后天
pickupStartTimestring预约起始时间(HH:mm),例如:09:00,顺丰必填
pickupEndTimestring预约截止时间(HH:mm),例如:10:00,顺丰必填
valinsPaystring保价额度,单位:元
passwordSigningstring是否口令签收,Y:需要 N: 不需要,默认值为N(德邦快递专属参数)
opstring是否开启订阅功能 0:不开启(默认) 1:开启 说明开启订阅功能时:pollCallBackUrl必须填入 此功能只针对有快递单号的单
pollCallBackUrlstring如果op设置为1时,pollCallBackUrl必须填入,用于跟踪回调
resultv2string添加此字段表示开通行政区域解析功能 。
0:关闭(默认)
1:开通行政区域解析功能以及物流轨迹增加物流状态名称
4:开通行政解析功能以及物流轨迹增加物流高级状态名称、状态值并且返回出发、目的及当前城市信息(详见:快递信息推送接口文档)
returnTypestring面单返回类型,默认为空,不返回面单内容。10:设备打印,20:生成图片短链回调。
siidstring设备码,returnType为10时必填
tempidstring模板编码,通过管理后台的电子面单模板信息获取 ,returnType不为空时必填
printCallBackUrlstring打印状态回调地址,returnType为10时必填

1.3 返回结果

字段类型说明备注
resultboolean提交结果true提交成功,false失败
returnCodestring返回编码
messagestring返回报文描述
datadata

data数据结构

字段类型说明备注
taskIdstring任务ID
orderIdstring订单ID
kuaidinumstring快递单号
eOrderstring快递面单附属属性,根据各个快递公司返回属性

eOrder数据结构

字段类型说明备注
bulkpenstring大头笔用于显示于电子面单上规定位置,非必需,是否有值取决于快递公司
orgCodestring始发地区域编码
orgNamestring始发地/始发网点名称
destCodestring目的地区域编码
destNamestring目的地/到达网点
orgSortingCodestring始发分拣编码
orgSortingNamestring始发分拣名称
destSortingCodestring目的分栋编码
destSortingNamestring目的分栋中心名称
orgExtrastring始发其他信息
destExtrastring目的其他信息
pkgCodestring集包编码
pkgNamestring集包地名称
roadstring路区
qrCodestring二维码
kdComOrderNumstring快递公司订单号
expressCodestring快递业务类型编码
expressNamestring快递业务类型名称
waterMarkstring水印
agingNamestring时效
abFlagstring电子产品类型图标
proCodestring时效产品图标
codingMappingstring进港映射码
codingMappingOutstring出港信息
printIconstring图标名称
destRouteLabelstring目的地(路由信息)
twoDimensionCodestring二维码信息
xbFlagstring顺丰面单标识,快运必填,xbFlag=1,打印SX标;xbFlag=2,打印融通标

注意:eOrder实际返回的字段各家快递公司不同,以实际返回为准

1.4 提供数据内容

请求参数示例

method = bOrder
key = ******
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1647258957705
param = {
	"kuaidicom": "yuantong",
	"recManName": "王超",
	"recManMobile": "13842569988",
	"recManPrintAddr": "广东深圳市深圳市南山区科技南十二路2号金蝶软件园",
	"sendManName": "王大",
	"sendManMobile": "13842569988",
	"sendManPrintAddr": "广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10",
	"cargo": "文件",
	"callBackUrl": "http: //www.baidu.com",
	"payment": "SHIPPER",
	"serviceType": "标准快递",
	"weight": "1",
	"remark": "",
	"salt": "",
	"dayType": "",
	"pickupStartTime": "",
	"pickupEndTime": "",
	"passwordSigning": "Y",
	"valinsPay": "",
	"op": "0",
	"pollCallBackUrl": "",
	"resultv2": "0",
	"returnType": "",
	"siid": "",
	"tempid": "",
	"printCallBackUrl": ""
}

返回结果示例

{
	"result": true,
	"returnCode": "200",
	"message": "提交成功",
	"data": {
		"taskId": "", // 任务ID
		"orderId": "" // 订单ID
		"kuaidinum": "" // 快递单号
		"eOrder": "[\"destName\":null,\"orgName\":null,\"pkgCode\":null,\"pkgName\":null,\"bulkpen\":\"上海-S33-K27-P\",\"orgExtra\":null}]"
	}
}

说明:

信息代码信息内容描述原因及建议处理方式
200提交成功提交成功
400参数错误等请根据技术文档请求,注意参数类型及是否必填
500服务器错误快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误
501重复提交重复提交了请求
503验证签名失败请检查加密方式,param + t + key + secret 的顺序进行MD5加密,加密后字符串转大写,不用加上“+”号
600您不是合法的用户(即授权Key出错)账号无可用余额,需要充值
601KEY已过期账号无可用余额,需要充值
700错误的回调地址检查回调地址,或者联系快递100工作人员

二、下单回调接口

订单有状态变更是会触发回调,回调后如果没有得到合作方正确返回,会重复回调多2次,即最多回调3次。间隔30分钟。

2.1 接口格式

提供统一格式的HTTP POST,并返回统一格式JSON数据。

请求报头:Content-Type=application/x-www-form-urlencoded;charset=UTF-8

2.2 请求地址

请求参数:

字段类型说明备注
taskIdstring任务ID
signstring签名32位大写签名,MD5 (param +salt)
paramparam参数主体

param数据结构:

参数名是否必填类型说明
kuaidicomstring快递公司的编码,一律用小写字母,见《快递公司编码》,选填。
kuaidinumstring快递单号,单号的最大长度是32个字符。
statusstring状态码
messagestring状态描述
datadata订单内容

data数据结构:

参数名是否必填类型说明
orderIdstring平台订单ID
statusint订单状态: 0:'下单成功'; 1:'已接单'; 2:'收件中'; 9:'用户主动取消'; 10:'已取件'; 11:'揽货失败'; 12:'已退回'; 13:'已签收'; 14:'异常签收';15:'已结算' ;99:'订单已取消';101:'运输中';200:'已出单';201:'出单失败'
courierNamestring快递员姓名
courierMobilestring快递员电话
weightstring计费重量,单位:kg
defPricestring标准运费,单位:元
freightstring折后运费,单位:元
volumestring体积,单位:cm³
actualWeightstring称重重量,单位:kg
ΘfeeDetailslist费用明细,明细项目请展开
└ feeTypestring费用类型,参考八、费用类型(feeType)说明
└ feeDescstring费用名称
└ amountstring费用明细金额,单位:元
└ payStatusstring支付状态,支付失败:-1;未支付:0;已支付:1 ;无需支付:2;已退款:3
printTaskIdstring打印任务ID
labelstring面单短链,下单请求中returnType为20时返回

2.3 返回结果

字段说明备注
result提交结果true提交成功,false失败
returnCode返回编码
message返回报文描述

2.4 提供数据内容

请求参数示例


taskId = ** ** **
	sign = ** ** **
	param = {
		"kuaidicom": "yuantong",
		"kuaidinum": "1234567890",
		"status": "200",
		"message": "成功",
		"data": {
			"orderId": "*****",
			"status": "0",
			"courierName": "王大",
			"courierMobile": "13842569988",
			"weight": "1",
			"defPrice": "15.0",
			"freight": "5.1",
			"volume": "120",
			"actualWeight": "1",
			"feeDetails": [{
				"feeType": "PACKAGINGFEE",
				"feeDesc": "包装费",
				"amount": "0.8",
				"payStatus": 1
			}],
			"printTaskId": "*****",
			"imgBase64": "*****"


		}
	}

返回结果示例

{

		"result":true,

		"returnCode":"200",

		"message":"成功"

} 

2.4 回调响应报文及错误码解释

字段名称字段含义
resulttrue表示成功,false表示失败。如果提交回调接口的地址失败,30分钟后重新回调,3次仍旧失败的,自动放弃
returnCode200: 提交成功 500: 服务器错误 其他错误请自行定义
message返回的提示

三、商家寄件下单取消接口

对下完单进行取消操作

3.1 接口格式

提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。

3.2 请求地址

https://poll.kuaidi100.com/order/borderapi.do

请求参数:

参数名是否必填类型说明
methodstring业务类型(默认:cancel)
keystring授权码,请到快递100页面申请企业版接口获取
signstring32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号secret在授权邮件里面有
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param数据结构:

参数名是否必填类型说明
taskIdstring任务ID
orderIdstring订单ID
cancelMsgstring取消原因,例:暂时不寄件了

3.3 返回结果

字段类型说明备注
resultboolean提交结果true提交成功,false失败
returnCodestring返回编码
messagestring返回报文描述
datadata 这里默认为空

3.4 提供数据内容

请求参数示例

method = cancel
key = ******
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1647258957705
param = {
	"taskId": "*****",
	"orderId": "*****",
	"cancelMsg": "暂时不寄件了"
}

返回结果示例

{

		"result":true,

		"returnCode":"200",

		"message":"取消成功",

		"data":{}

} 

说明:

信息代码信息内容描述原因及建议处理方式
200提交成功提交成功
400参数错误等请根据技术文档请求,注意参数类型及是否必填
500服务器错误快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,或者对已取消的订单重复操作取消,也会报此错误
501重复提交重复提交了请求
503验证签名失败请检查加密方式,param + t + key + secret 的顺序进行MD5加密,加密后字符串转大写,不用加上“+”号
600您不是合法的用户(即授权Key出错)账号无可用余额,需要充值
601KEY已过期账号无可用余额,需要充值
700错误的回调地址检查回调地址,或者联系快递100工作人员

四、商家寄件下单价格接口

查看从出发地到目的地的价格

4.1 接口格式

提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。

4.2 请求地址

https://poll.kuaidi100.com/order/borderapi.do

请求参数:

参数名是否必填类型说明
methodstring业务类型(默认:price)
keystring授权码,请到快递100页面申请企业版接口获取
signstring32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号secret在授权邮件里面有
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param数据结构:

参数名是否必填类型说明
kuaidiComstring快递公司编码
sendManPrintAddrstring出发地地址,最小颗粒到市级,例如:广东省深圳市
recManPrintAddrstring目的地地址,最小颗粒到市级,例如:广东省深圳市
weightstring重量,单位:kg
serviceTypestring业务类型

4.3 返回结果

字段类型说明备注
resultboolean提交结果true提交成功,false失败
returnCodestring返回编码
messagestring返回报文描述
datadata运力对象

data数据结构:

参数名类型说明
defFirstPricestring标准首重价格,单位:元
defOverPricestring标准续重价格,单位:元
defPricestring标准总价,单位:元
firstPricestring折后首重价格,单位:元
overPricestring折后续重价格,单位:元
pricestring折后总价,单位:元
serviceTypestring业务类型

4.4 提供数据内容

请求参数示例

method = price
key = ******
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1647258957705
param = {
	"kuaidicom": "yuantong",
	"sendManPrintAddr": "广东深圳市深圳市南山区科技南十二路2号金蝶软件园",
	"recManPrintAddr": "广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10",
	"weight": "1",
	"serviceType": "标准快递"
}

返回结果示例

{
	"data": {
		"firstPrice": "8.0",
		"defPrice": "8.0",
		"defFirstPrice": "8.0",
		"price": "8.0",
		"serviceType": "标准快递",
		"overPrice": "0",
		"defOverPrice": "0",
		"kuaidiCom": "zhongtong"
	},
	"message": "成功",
	"result": true,
	"returnCode": "200"
}

说明:

信息代码信息内容描述原因及建议处理方式
200提交成功提交成功
400参数错误等请根据技术文档请求,注意参数类型及是否必填
500服务器错误快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误
503验证签名失败请检查加密方式,param + t + key + secret 的顺序进行MD5加密,加密后字符串转大写,不用加上“+”号
600您不是合法的用户(即授权Key出错)账号无可用余额,需要充值
601KEY已过期账号无可用余额,需要充值

五、快递信息推送接口

5.1 推送请求地址

由贵司在下单开启订阅功能中通过pollCallBackUrl字段提供

5.2 推送请求类型

post

5.3 推送输入参数

请求参数(header)

名称类型默认值
Content-Typestringapplication/x-www-form-urlencoded

请求参数(body)

名称类型示例值描述
signString 订阅参数salt值不为null时,推送数据将包含该加密签名,加密方式:md5(param+salt)。注意: salt值为空串时,推送的数据也会包含sign。
Θparam 由其他字段拼接
└ statusStringpolling监控状态:polling:监控中,shutdown:结束,abort:中止,updateall:重新推送。其中当快递单为已签收时status=shutdown,当message为“3天查询无记录”或“60天无变化时”status= abort ,对于status=abort的状态,需要增加额外的处理逻辑
└ billstatusStringgot包括got、sending、check三个状态,由于意义不大,已弃用,请忽略
└ messageString 监控状态相关消息,如:3天查询无记录,60天无变化
└ autoCheckString1快递公司编码是否出错,0为本推送信息对应的是贵司提交的原始快递公司编码,1为本推送信息对应的是我方纠正后的新的快递公司编码。一个单如果我们连续3天都查不到结果,我方会(1)判断一次贵司提交的快递公司编码是否正确,如果正确,给贵司的回调接口(callbackurl)推送带有如下字段的信息:autoCheck=0、comOld与comNew都为空;(2)如果贵司提交的快递公司编码出错,我们会帮忙用正确的快递公司编码+原来的运单号重新提交订阅并开启监控(后续如果监控到单号有更新就给贵司的回调接口(callbackurl)推送带有如下字段的信息:autoCheck=1、comOld=原来的公司编码、comNew=新的公司编码);并且给贵方的回调接口(callbackurl)推送一条含有如下字段的信息:status=abort、autoCheck=0、comOld为空、comNew=纠正后的快递公司编码。
└ comOldStringyuantong贵司提交的原始的快递公司编码。详细见autoCheck后说明。若开启了国际版(即在订阅请求中增加字段interCom=1),则回调请求中暂无此字段
└ comNewStringems我司纠正后的新的快递公司编码。详细见autoCheck后说明。若开启了国际版(即在订阅请求中增加字段interCom=1),则回调请求中暂无此字段
ΘlastResultlastResult 最新查询结果,若在订阅报文中通过interCom字段开通了国际版,则此lastResult表示出发国的查询结果,全量,倒序(即时间最新的在最前)
└- messageString 消息体,请忽略
└- stateString0快递单当前状态,默认为0在途,1揽收,2疑难,3签收,4退签,5派件,8清关,14拒签等10个基础物流状态,如需要返回高级物流状态,请参考 resultv2 传值
└- statusString200通讯状态,请忽略
└- conditionStringF00快递单明细状态标记,暂未实现,请忽略
└- ischeckString0是否签收标记,0未签收,1已签收
└- comStringyuantong快递公司编码,一律用小写字母
└- nuStringV030344422单号
└- dataObject 数组,包含多个对象,每个对象字段如展开所示
└-- contextString上海分拨中心/装件入车扫描内容
└-- timeString2012-08-28 16:33:19时间,原始格式
└-- ftimeString2012-08-28 16:33:19格式化后时间
└-- statusString在途物流状态名称或者高级状态名称,提交resultv2=1或者resultv2=4标记后才会出现
└-- areaCodeString310000000000本数据元对应的行政区域的编码,提交resultv2=1或者resultv2=4标记后才会出现
└-- areaNameString上海市本数据元对应的行政区域的名称,提交resultv2=1或者resultv2=4标记后才会出现
└--areaCenterString17.200983,39.084158本数据元对应的行政区域经纬度,提交resultv2=4标记后才会出现
└--locationString深圳中心本数据元对应的快件当前位置,提交resultv2=4标记后才会出现
└--areaPinYinStringtianjin本数据元对应的行政区域拼音,提交resultv2=4标记后才会出现
Θ destResultdestResult 表示最新的目的国家的查询结果,只有在订阅报文中通过interCom=1字段开通了国际版才会显示此数据元,全量,倒序(即时间最新的在最前)
└- messageString 消息体,请忽略
└- stateString0快递单当前状态,默认为0在途,1揽收,2疑难,3签收,4退签,5派件,8清关,14拒签等10个基础物流状态,如需要返回高级物流状态,请参考 resultv2 传值
└- statusString200通讯状态,请忽略
└- conditionStringF00快递单明细状态标记,暂未实现,请忽略
└- ischeckString0是否签收标记,0未签收,1已签收
└- comStringyuantong快递公司编码,一律用小写字母
└- nuStringV030344422单号
Θ datadata 数组,包含多个对象,每个对象字段如展开所示
└-- contextString上海分拨中心/装件入车扫描内容
└-- timeString2012-08-28 16:33:19时间,原始格式
└-- ftimeString2012-08-28 16:33:19格式化后时间
└-- statusString在途本数据元对应的物流状态名称或者高级状态名称,提交resultv2=1或者resultv2=4标记后才会出现
└-- areaCodeString310000000000本数据元对应的行政区域的编码,提交resultv2=1或者resultv2=4标记后才会出现
└-- areaNameString上海市本数据元对应的行政区域的名称,提交resultv2=1或者resultv2=4标记后才会出现
└--areaCenterString17.200983,39.084158本数据元对应的行政区域经纬度,提交resultv2=4标记后才会出现
└--locationString深圳中心本数据元对应的快件当前位置,提交resultv2=4标记后才会出现
└--areaPinYinStringtianjin本数据元对应的行政区域拼音,提交resultv2=4标记后才会出现

5.4 推送输入参数示例

{
	"status": "polling",
	"billstatus": "got",
	"message": "寄件",
	"lastResult": {
		"message": "ok",
		"nu": "YT6186594166532",
		"ischeck": "0",
		"com": "yuantong",
		"status": "200",
		"data": [{
				"time": "2021-12-15 20:15:14",
				"context": "【苏州转运中心】 已发出 下一站 【无锡转运中心公司】",
				"ftime": "2021-12-15 20:15:14",
				"areaCode": "CN320500000000",
				"areaName": "江苏,苏州市",
				"status": "干线",
				"location": "",
				"areaCenter": "120.585315,31.298886",
				"areaPinYin": "su zhou shi",
				"statusCode": "1002"
			},
			{
				"time": "2021-12-15 20:11:25",
				"context": "【苏州转运中心公司】 已收入",
				"ftime": "2021-12-15 20:11:25",
				"areaCode": "CN320500000000",
				"areaName": "江苏,苏州市",
				"status": "干线",
				"location": "",
				"areaCenter": "120.585315,31.298886",
				"areaPinYin": "su zhou shi",
				"statusCode": "1002"
			},
			{
				"time": "2021-12-15 19:18:27",
				"context": "【江苏省无锡市锡新开发区公司】 已收入",
				"ftime": "2021-12-15 19:18:27",
				"areaCode": "CN320200000000",
				"areaName": "江苏,无锡市",
				"status": "在途",
				"location": "",
				"areaCenter": "120.31191,31.491169",
				"areaPinYin": "wu xi shi",
				"statusCode": "0"
			},
			{
				"time": "2021-12-15 17:10:09",
				"context": "【江苏省苏州市北桥公司】 已揽收",
				"ftime": "2021-12-15 17:10:09",
				"areaCode": "CN320507004000",
				"areaName": "江苏,苏州市,相城区,北桥",
				"status": "揽收",
				"location": "",
				"areaCenter": "120.606531,31.505825",
				"areaPinYin": "bei qiao jie dao",
				"statusCode": "1"
			}
		],
		"state": "0",
		"condition": "F00",
		"routeInfo": {
			"from": {
				"number": "CN320507004000",
				"name": "江苏,苏州市,相城区,北桥"
			},
			"cur": {
				"number": "CN320200000000",
				"name": "江苏,无锡市"
			},
			"to": null
		},
		"isLoop": false
	}
}

5.5 运单签收状态服务说明

物流状态值 物流状态名称 高级物流状态值 高级物流状态名称 含义
1 揽收 1 揽收 快件揽件
101 已下单 已经下快件单
102 待揽收 待快递公司揽收
103 已揽收 快递公司已经揽收
0 在途 0 在途 快件在途中
1001 到达派件城市 快件到达收件人城市
1002 干线 快件处于运输过程中
1003 转递 快件发往到新的收件地址
5 派件 5 派件 快件正在派件
501 投柜或驿站 快件已经投递到快递柜或者快递驿站
3 签收 3 签收 快件已签收
301 本人签收 收件人正常签收
302 派件异常后签收 快件显示派件异常,但后续正常签收
303 代签 快件已被代签
304 投柜或驿站签收 快件已由快递柜或者驿站签收
6 退回 6 退回 快件正处于返回发货人的途中
4 退签 4 退签 此快件单已退签
401 已销单 此快件单已撤销
14 拒签 收件人拒签快件
7 转投 7 转投 快件转给其他快递公司邮寄
2 疑难 2 疑难 快件存在疑难
201 超时未签收 快件长时间派件后未签收
202 超时未更新 快件长时间没有派件或签收
203 拒收 收件人发起拒收快递,待发货方确认
204 派件异常 快件派件时遇到异常情况
205 柜或驿站超时未取 快件在快递柜或者驿站长时间未取
206 无法联系 无法联系到收件人
207 超区 超出快递公司的服务区范围
208 滞留 快件滞留在网点,没有派送
209 破损 快件破损
8 清关 8 清关 快件清关
10 待清关 快件等待清关
11 清关中 快件正在清关流程中
12 已清关 快件已完成清关流程
13 清关异常 货物在清关过程中出现异常
14 拒签 \ \ 收件人拒签快件

注:如需物流状态高级状态名称及状态值需要 resultv2 传 “6” 返回

5.6 推送响应报文及错误码解释

字段名称字段含义
resulttrue表示成功,false表示失败。如果提交回调接口的地址失败,30分钟后重新回调,3次仍旧失败的,自动放弃
returnCode200: 提交成功 500: 服务器错误 其他错误请自行定义
message返回的提示

5.7 推送返回示例

当我方调用贵方的回调接口(pollCallBackUrl)时,贵方需要先将我方提交的数据保存至贵方的数据库,接着向我方返回是否成功接收的响应报文及代码,即贵公司直接在回调接口的地址的response中填写如下内容:

{
    "result":true,
    "returnCode":"200",
    "message":"成功"
}      

注意:对于status= abort(message中包含“3天查询无记录”或者“60天无变化”)的快递单,也需要返回成功接收的响应报文及代码。

六、快递公司编码

快递公司编码
京东jd
德邦debangkuaidi
顺丰shunfeng
极兔jtexpress
圆通yuantong
申通shentong
中通zhongtong

七、业务类型参数表

快递公司名称 业务类型
jd(京东) 特惠送
特快送
debangkuaidi(德邦) 标准快递
德邦大件360
shunfeng(顺丰) 顺丰标快
顺丰特快
jtexpress(极兔) 标准快递
yuantong(圆通) 标准快递
shentong(申通) 标准快递
zhongtong(中通) 标准快递

八、费用类型(feeType)说明

类型说明
INSURANCEFEE保价费
PACKAGINGFEE包装费
COLLECTIONFEE代收货款
SIGNANDRETURN签单返还
HANDLINGCHARGES装卸服务
PICKUPSERVICEFEE提货服务
DELIVERYSERVICEFEE配送服务
RESOURCECONDITIONINGCHARGES资源调节费
ANIMALQUARANTINECERTIFICATE动检证
SPECIALWAREHOUSINGFEE特殊入仓
SURCHARGE附加费
EXPRESSCOMPENSATION快递赔付费
RECEIVEDELIVERYFEECLAIMS收派服务费-理赔
EXPRESSADDRCHANGEFEE快递改址费
EXCEEDEDAREAFEE超区服务费
OVERLENGTHOVERWEIGHTFEE超长超重附加费
RETURNFEE逆向费用
FRESHFEE保鲜服务费

九、商家寄件订单详情查询接口

查询通过商家寄件下单接口下单的订单详情信息

9.1 接口格式

提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。

9.2 请求地址

https://order.kuaidi100.com/order/borderapi.do

9.3 请求参数

参数名是否必填类型说明
methodstring业务类型(默认:detail)
keystring授权码,请到快递100页面申请企业版接口获取
signstring32位大写签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号secret在授权邮件里面有
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param数据结构:

参数名是否必填类型说明
taskIdstring下单时返回的任务ID

9.4 返回结果

字段类型说明备注
resultboolean提交结果true提交成功,false失败
returnCodestring返回编码
messagestring返回报文描述
datadata

data数据结构

字段类型说明
taskIdstring任务ID
createTimedate下单时间
orderIdstring订单ID
kuaidiComstring快递公司
kuaidiNumstring快递单号
sendNamestring寄件人姓名
sendMobilestring寄件人联系方式
sendProvincestring寄件人省份
sendCitystring寄件人城市
sendDistrictstring寄件人区
sendAddrstring寄件人详细地址
recNamestring收件人姓名
recMobilestring收件人联系方式
recProvincestring收件人省份
recCitystring收件人城市
recDistrictstring收件人区
recAddrstring收件人详细地址
valinsstring保价费用
cargostring物品名称
serviceTypestring业务类型
preWeightstring用户端输入重量,单位:kg
lastWeightstring快递公司返回最终重量 ,单位:kg
commentstring备注内容
dayTypestring预约日期
pickupStartTimestring预约时间
pickupEndTimestring预约截止时间
paymentstring支付方式,SHIPPER: 寄付,CONSIGNEE: 到付, MONTHLY:月结
freightstring折后运费,单位:元
courierNamestring快递员姓名
courierMobilestring快递员联系方式
statusInteger订单状态: 0:'下单成功'; 1:'已接单'; 2:'收件中'; 9:'用户主动取消'; 10;'已取件'; 11;'揽货失败'; 12;'已退回'; 13;'已签收'; 14;'异常签收';15;'已结算' 99;'订单已取消'101;'运输中';200:'已出单'201:'出单失败'
payStatusInteger支付状态,0:预扣款,1:已支付,3:退款中,4:已退款
defPriceInteger标准运费,单位:元
ΘfeeDetailslist费用明细,明细项目请展开
└ feeTypestring费用类型,参考八、费用类型(feeType)说明
└ feeDescstring费用名称
└ amountstring费用明细金额,单位:元
└ payStatusstring支付状态,支付失败:-1;未支付:0;已支付:1 ;无需支付:2;已退款:3

9.5 返回参数示例

{
	"data": {
		"cargo": "普货",
		"comment": null,
		"courierMobile": null,
		"courierName": null,
		"createTime": "2022-04-22 01:23:40",
		"dayType": null,
		"freight": null,
		"feeDetails": [{
			"feeType": "",
			"feeDesc": "",
			"amount": "",
			"payStatus": ""
		}],
		"kuaidiCom": "jd",
		"kuaidiNum": "JDVC13641480904",
		"lastWeight": null,
		"orderId": "20274573",
		"payStatus": 4,
		"payment": "SHIPPER",
		"pickupEndTime": null,
		"pickupStartTime": null,
		"preWeight": "1",
		"defPrice": null,
		"recAddr": "长安塘村长兴工业区12号3楼",
		"recCity": "东莞市",
		"recDistrict": "东坑镇",
		"recMobile": "13788880231",
		"recName": "李谬朵",
		"recProvince": "广东",
		"sendAddr": "蔡子池街道新大陆国际监控室",
		"sendCity": "衡阳市",
		"sendDistrict": "耒阳市",
		"sendMobile": "13788880231",
		"sendName": "李新红",
		"sendProvince": "湖南",
		"serviceType": "特惠送",
		"status": 9,
		"taskId": "44B0108CF44728E6F8A121177E3212B2",
		"valins": null
	},
	"message": "成功",
	"result": true,
	"returnCode": "200"
}

说明:

信息代码信息内容描述原因及建议处理方式
200提交成功提交成功
400参数错误等请根据技术文档请求,注意参数类型及是否必填
500服务器错误快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误
503验证签名失败请检查加密方式,param + t + key + secret 的顺序进行MD5加密,加密后字符串转大写,不用加上“+”号
600您不是合法的用户(即授权Key出错)账号无可用余额,需要充值
601KEY已过期账号无可用余额,需要充值

十、电子面单复打接口

该接口支持在提交打印请求2天内的打印任务进行复打10次的操作(仅对下单时returnType=10的支持复打操作)。

10.1 接口格式

提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。

10.2 请求地址

https://api.kuaidi100.com/label/order

请求参数:

参数名是否必填类型说明
methodstring业务类型(默认:printOld)
keystring授权码,请申请企业版获取
signstring32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号secret在企业管理后台查看
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param数据结构:

参数名是否必填类型说明
printTaskIdstring任务ID
siidstring快递100打印机,不填默认为下单时填入的siid

10.3 返回结果

字段类型说明备注
successboolean提交结果true提交成功,false失败
codestring返回编码
messageString返回报文描述
dataString图片复打时会有返回

10.4 提供数据内容

打印设备复打成功返回示例

{
	"code": 200,
	"message": "success",
	"time": 0,
	"success": true
} 

错误示例:

{
	"code": 30009,
	"message": "查无此单",
	"time": 0,
	"success": false
} 

10.5 返回信息代码含义

信息代码信息内容描述原因及建议处理方式
-1服务器错误快递100的服务器出现间歇或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误
200提交成功提交成功
30001参数错误请根据技术文档请求,注意参数类型及是否必填
30002验证签名失败检查加密方式,param +t+key+ secret的顺序进行MD5加密,加密后字符串转32位大写,不用加上“+”号
30003账号信息不正确检查key是否正确
30004账号单量不足单量不足需要充值
30009查无此单可能调用过期或复打次数超过限制