文档中心
快递可用性接口文档 API调试工具

一、快递可用性接口

通过收寄件地址判断该线路是否可寄送,返回内容包括寄件地址可达性,收件地址可达性,以及可提供寄件服务的快递公司。

1.1 接口格式

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

1.2 请求地址

http://api.kuaidi100.com/reachable.do

1.3 请求参数

请求参数(header)

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

请求参数(body)

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

param数据结构

参数名称数据类型是否必填参数描述
recManNamestring收件人姓名
recManMobilestring收件人的手机号
recManPrintAddrstring收件人所在完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园
sendManNamestring寄件人姓名
sendManMobilestring寄件人的手机号
sendManPrintAddrstring寄件人所在完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园
kuaidiComsstring快递公司编码,如yuantong,shunfeng,支持一次传入多个,支持的快递公司及编码见本文档1.8 支持快递公司列表

1.4 请求参数示例

{
	"recManPrintAddr": "浙江省湖州市吴兴区织****",
	"sendManPrintAddr": "福建省宁德市霞***",
	"recManMobile": "****",
	"sendManName": "****",
	"recManName": "***",
	"kuaidiComs": "yuantong,ems,youzhengguonei",
	"sendManMobile ": "*****"
}

1.5 返回结果

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

data数据结构

字段类型说明备注
taskIdstring任务ID
fromReachableInteger寄件地址可达性
toReachablestring收件地址可达性

fromReachabledata数据结构

字段类型说明备注
expressCodestring快递公司编码
reachablestring是否可达,0:不可达,1:可达
reasonstring不可达的原因

toReachable数据结构

字段类型说明备注
expressCodestring快递公司编码
reachablestring是否可达,0:不可达,1:可达
reasonstring不可达的原因

1.6 返回参数示例


{
	"message": "成功",
	"returnCode": "200",
	"result": true,
	"data": {
		"taskId": "E9E0AA920791542C8D491968DC5601E3",
		"fromReachable": [],
		"toReachable": [{
			"reachable": 1,
			"expressCode": "yuantong"
		}, {
			"reachable": 1,
			"expressCode": "ems"
		}, {
			"reachable": 1,
			"expressCode": "youzhengguonei"
		}]
	}
}

1.7 信息代码含义

信息代码信息内容描述原因及建议处理方式
200成功成功
201行政区解析失败检查地址中行政区域信息是否正确、完整
400请求参数错误请根据技术文档请求,注意参数类型及是否必填
503验证签名失败检查加密方式,param +t+key+ secret的顺序进行MD5加密,加密后字符串转32位大写,不用加上“+”号
601key已过期没有可用单量,账号不存在或者没有该接口权限
600您不是合法的用户授权key出错或账户无可用单量

1.8 支持快递公司列表

快递公司名称编码
圆通yuantong
顺丰速运shunfeng
京东快递jd
中通快递zhongtong
申通快递shentong
韵达快递yunda
EMSems
极兔速递jtexpress
宅急送zhaijisong
德邦快递debangkuaidi
邮政快递包裹youzhengguonei