快递100 API

快递订阅查询快递api接口技术文档

POSThttps://poll.kuaidi100.com/poll

一、订阅接口
通过订阅接口提交快递单号，接口接收到后便对这些运单进行跟踪，当运单状态发生变化的时候，通过调用回调接口将运单的跟踪信息推送给贵公司，直到这些运单号的生命周期结束（一般以“已签收”为准）。

注意：对于同一快递公司同一个快递单号，每月最大订阅次数为4次，超过4次的订阅在提交时会报重复订阅。

名称	类型	是否必需	示例值	描述
schema	String	是	json	返回的数据格式
Θparam	param	是		由其他字段拼接
└ company	String	是	ems	订阅的快递公司的编码，一律用小写字母
└ number	String	是	1136281381675	订阅的快递单号，单号的最大长度是32个字符下载编码表格
└ from	String	否	广东省深圳市南山区	出发地城市，省-市-区，非必填，填了有助于提升签收状态的判断的准确率，请尽量提供
└ to	String	否	北京市朝阳区	目的地城市，省-市-区，非必填，填了有助于提升签收状态的判断的准确率，且到达目的地后会加大监控频率，请尽量提供
└ key	String	是		授权码，请申请企业版获取
Θparameters	parameters	是		附加参数信息
└- callbackurl	String	是		回调接口的地址
└- salt	String	否	XXXXXXXXXX	签名用随机字符串
└- resultv2	String	否	1	添加此字段表示开通行政区域解析功能。0：关闭（默认），1：开通行政区域解析功能以及物流轨迹增加物流状态值，2：开通行政解析功能以及物流轨迹增加物流状态值并且返回出发、目的及当前城市信息 4：开通行政解析功能以及物流轨迹增加物流高级状态名称并且返回出发、目的及当前城市信息 6:开通行政解析功能以及物流轨迹增加物流高级状态名称、状态值并且返回出发、目的及当前城市信息
└- autoCom	String	否	1	添加此字段且将此值设为1，则表示开启智能判断单号所属公司的功能，开启后，需确保company字段为空,即只传运单号（number字段），我方收到后会根据单号判断出其所属的快递公司（即company字段）。建议只有在无法知道单号对应的快递公司（即company的值）的情况下才开启此功能。
└- interCom	String	否	1	添加此字段表示开启国际版，开启后，若订阅的单号（即number字段）属于国际单号，会返回出发国与目的国两个国家的跟踪信息，本功能暂时只支持邮政体系（国际类的邮政小包、EMS）内的快递公司，若单号我方识别为非国际单，即使添加本字段，也不会返回destResult元素组
└- departureCountry	String	否	CN	出发国家编码
└- departureCom	String	否	ems	出发的快递公司的编码
└- destinationCountry	String	否	JP	目的国家编码
└- destinationCom	String	否	japanposten	目的的快递公司的编码
└- phone	String	否	13488888888	收、寄件人的电话号码（手机和固定电话均可，只能填写一个，顺丰速运和丰网速运必填，其他快递公司选填。如座机号码有分机号，分机号无需上传。）

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

1.5 订阅返回信息代码含义

result: true表示成功，false表示失败

信息代码	信息内容描述	原因及建议处理方式
200	提交成功	订阅提交成功
500	服务器错误	快递100的服务器出理间隙或临时性异常，有时如果因为不按规范提交请求，比如快递公司参数写错等，也会报此错误
501	重复订阅	此单已经订阅成功且目前还在跟踪过程中。若要提交多次订阅，请在收到单号的status=abort或shutdown后隔半小时再提交订阅
502	提交内容含有敏感关键字，被安全防护拦截	回调地址、提交内容包含敏感词，请联系快递100工作人员
600	您不是合法的订阅者（即授权Key出错）	账号无可用单量，需要充值
601	POLL: KEY 已过期	账号无可用单量，需要充值
700	不支持的快递公司	拒绝订阅的快递公司，检查快递公司编码是否有误
701	订阅方的订阅数据存在错误（如不支持的快递公司、单号为空、单号超长等）或错误的回调地址	请检查快递公司编码、对照技术文档检查参数、在后台调试工具测试回调地址
702	POLL:识别不到该单号对应的快递公司	快递公司编码错误或者无可用单量，需要充值

请求参数

Body 参数application/x-www-form-urlencoded

schema

string

返回的数据格式

必需

示例值:

json

param

string

由其他字段拼接

必需

示例值:

{ "company": "ems", "number": "1136281381675", "from": "广东省深圳市南山区", "to": "北京市朝阳区", "key": "XXX ", "parameters": { "callbackurl": "您的回调接口的地址，如http://www.您的域名.com/kuaidi?callbackid=...", "salt": "XXXXXXXXXX", "resultv2": "1", "autoCom": "1", "interCom": "1", "departureCountry": "CN", "departureCom": "ems", "destinationCountry": "JP", "destinationCom": "japanposten", "phone": "13800138000" }}

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

result

boolean

必需

returnCode

string

必需

message

string

必需

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

最后修改时间： 2 年前