快递100 API
  1. 接口文档
快递100 API
  • 入门指南
    • 如何注册企业账号
    • 如何开通产品服务
    • 如何联系工作人员
    • 企业版和基础版的区别
  • 产品文档
    • 快递查询
      • 实时快递查询
        • 产品介绍
        • 接口文档
          • 实时快递查询接口
      • 快递信息推送服务
        • 产品介绍
        • 接口文档
          • 快递订阅查询快递api接口技术文档
          • 推送接口
      • 快递查询地图轨迹
        • 产品介绍
        • 接口文档
          • 快递查询地图轨迹技术文档
      • 地图轨迹推送服务
        • 产品介绍
        • 接口文档
          • 订阅接口
            POST
          • 推送接口
            POST
    • 电子面单与云打印
      • 电子面单
        • 产品介绍
        • 电子面单参数
        • 第三方平台账号授权
          • 第三方授权回调
          • 第三方平台网点&面单余额接口
          • 电子面单账号授权
        • 电子面单接口
          • 打印状态回调
          • 电子面单下单接口
          • 电子面单复打接口
        • 电子面单取消接口
      • 订单导入
        • 产品介绍
        • 接口文档
          • 提交售后(退货)订单获取任务接口
          • 售后(退货)订单获取结果推送接口
          • 快递单号回传及订单发货接口
          • 获取店铺授权超链接接口
          • 提交订单获取任务接口
          • 订单获取结果推送接口
      • 自定义打印
        • 产品介绍
        • 自定义模板打印
          • 自定义模板打印接口
          • 自定义模板打印复打接口
          • 打印状态回调
          • 硬件状态查询接口
        • 附件打印
          • 附件打印接口
          • 附件打印复打接口
          • 打印状态回调
          • 硬件状态查询接口
        • 指令打印
          • 指令打印接口
          • 指令打印复打接口
          • 打印状态回调
          • 硬件状态查询接口
      • 发货单
        • 产品介绍
        • 接口文档
          • 发货单接口
          • 打印回调接口
    • 物流服务
      • 商家寄件
        • 产品介绍
        • 接口文档
          • 快递公司编码
          • 商家寄件下单接口
          • 下单回调接口
          • 商家寄件下单取消接口
          • 商家寄件下单价格接口
          • 快递信息推送接口
          • 商家寄件订单详情查询接口
          • 电子面单复打接口
      • 同城配送
        • 产品介绍
        • 参数字典
        • 同城配送接账号授权
          • 授权回调接口
          • 同城配送账号授权接口
        • 同城配送下单
          • 下单回调接口
          • 同城配送下单
        • 同城配送查询订单
        • 同城配送取消下单接口
      • C端寄件
        • 产品文档
        • 接口文档
          • C端寄件下单接口
          • 下单回调接口
          • C端寄件下单取消接口
          • C端寄件价格查询接口
          • 快递信息推送接口
    • 跨境服务
      • 国际电子面单API
        • 产品介绍
        • 参考数字典
        • 接口文档
          • 国际电子面单下单API
          • 预约取件API
          • 取消预约PI
    • 增值服务
      • 短信提醒发送
        • 产品介绍
        • 接口文档
          • 快递100短信回调请求
          • 快递100短信发送接口
      • 智能单号识别
        • 产品介绍
        • 智能识别接口说明
      • 快递面单OCR识别
        • 产品介绍
        • 快递面单OCR识别接口
      • 快递可用性查询
        • 产品介绍
        • 快递可用性接口
  • 常见问题
    • 查询类问题
      • 实时快递查询
      • 快递信息推送服务
      • 智能单号识别
      • 短信提醒发送
      • Excel表格批量查询
    • 电子面单类问题
      • 电子面单
      • 快递面单模板
      • 参数配置
      • 云打印机/云盒
    • 地图轨迹类问题
      • 快递查询地图轨迹
    • 物流类服务
      • 同城配送
      • 商家寄件
      • 个人寄件
    • 云打印类问题
      • 自定义打印
      • 云打印
      • 发货单
    • 申请与审核
      • 企业版
      • 基础版
    • 支付与支票
      • 产品价格
      • 账单与充值
      • 发票问题
    • 政策与规范
      • 商家寄件服务协议
      • 用户协议
      • 授权声明
      • 隐私政策
      • 增值服务
      • 服务协议
      • 保密协议
    • 账号与密码
      • 账号密码
      • 授权问题
    • 快递公司入驻
      • 入驻资料及审核
      • 电子面单接口示例
      • 快递公司接入快递100实时查询接口
      • 快递公司接入快递100订阅推送接口
      • 手机app快递查询接口
  1. 接口文档

推送接口

POST
/
推送请求地址:由贵司在订阅请求中通过callbackurl字段提供
参数名是否必填类型说明
sign否string订阅参数salt值不为空时,推送数据将包含该加密签名,加密方式:md5(param+salt)
param是Object主体参数对象
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),则回调请求中暂无此字段
lastResultObject最新查询轨迹结果
lastResult对应参数
字段名称类型字段含义
messageString消息体,请忽略
stateInteger快递单当前状态,默认为0在途,1揽收,2疑难,3签收,4退签,5派件,8清关,14拒签等10个主状态,如需要返回高级状态,请参考 resultv2 传值
statusInteger通讯状态,请忽略
conditionString快递单明细状态标记,暂未实现,请忽略
ischeckInteger是否签收标记,请忽略,明细状态请参考state字段
comString快递公司编码,一律用小写字母
nuString单号
trailUrlString轨迹地图链接
arrivalTimeString预计到达时间
totalTimeString平均耗时
remainTimeString到达还需多少时间
isLoopBoolean是否存在环路
ΘrouteInfo路由信息
└Θfrom出发地行政区信息
└number政区信息编码
└name政区信息名
└Θcur当前地行政区信息
└number政区信息编码
└name政区信息名
└Θto目的地行政区信息
└number政区信息编码
└name政区信息名
Θdatadata最新查询结果,数组,包含多项,全量,倒序(即时间最新的在最前),每项都是对象,对象包含字段请展开
└ contextString内容
└ timeString时间,原始格式
└ ftimeString格式化后时间
└statusString本数据元对应的签收状态,只有实时查询接口中提交resultv2标记后才会出现
└areaCodeString本数据元对应的行政区域的编码,只有实时查询接口中提交resultv2标记后才会出现
└areaNameString本数据元对应的行政区域的名称,只有实时查询接口中提交resultv2标记后才会出现

2.5 轨迹链接应用示例#

img
重要提醒:
(1)对于status= abort而且message中包含“3天”关键字而且comNew为空的快递单,需要增加以下处理逻辑:
如果有专门的工作人员,可以:将快递单罗列给工作人员,由工作人员判断此单是否为假单:如果此单是真实单,则将此单重新向快递100提交一次;如果此单是假单,则将此单标记为假单,而且不再将此单提交给快递100。如果没有专门的工作人员,请直接用以下第二种方法进行操作;
如果没有专门的工作人员,可以:在收到status=abort而且message中包含“3天”关键字而且comNew为空的提示10分钟后,将此快递单重新向快递100提交订阅,如果重新提交后仍然收到status= abort,则再次重新向快递100提交,如此,在同一月中如果重复提交3~4次都仍然收到status= abort,则此单为假单,不需要再将此单提交给快递100。
对于同一自然月内重复提交的快递单,结算时只计一次费用,对于跨了两个自然月重复提交的结算单,结算两次费用。
(2)如果判断到status=abort且comNew不为空,则不需要重新提交订阅,且将贵司原来的快递公司编码改为comNew后的值,或在贵司数据库中增加一个快递公司编码为comNew+原来单号的运单;
(3)如果判断到status=polling且autoCheck=1,则此单为纠正公司编码后的跟踪信息,应保存。
关于data:我方每次推送的都是完整的、全量的快递查询结果,而不是部分最新、增量的状态。由于同一快递单查询结果的数据源可能变动,不同数据源之间的结果略有差异,建议每次删除旧的数据后再写入新的数据。
时间建议以ftime为准,不要使用time,time的存在仅仅为了兼容。

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

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

2.7 推送返回示例#

当我方调用贵方的回调接口(callbackurl)时,贵方需要先将我方提交的数据保存至贵方的数据库,接着向我方返回是否成功接收的响应报文及代码,即贵公司直接在回调接口的地址的response中填写如下内容:
{
    "result": true,
    "returnCode": "200",
    "message": "成功"
}
Copy
注意:对于status= abort(message中包含“3天查询无记录”或者“60天无变化”)的快递单,也需要返回成功接收的响应报文及代码。

2.8 运单签收状态(已签收、退回等)增值服务说明#

默认状态下,在推送时我们提供了ischeck字段表示快递单是否签收(含正常签收,退回签收两种情况),通过state字段提供签收的具体状态,state具体如下:
物流状态值物流状态名称高级物流状态值高级物流状态名称含义
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” 返回,如需物流状态高级状态名称需要 resultv2 传 “4” 返回

三、快递公司编码#

下载表格
如果您需要的公司不在此列表,请联系在线客服添加
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https:///' \
--data-urlencode 'param={	"status": "polling",	"billstatus": "got",	"message": "",	"autoCheck": "1",	"comOld": "yuantong",	"comNew": "ems",	"lastResult": {		"message": "ok",		"state": "0",		"status": "200",		"condition": "F00",		"ischeck": "0",		"com": "yuantong",		"nu": "V030344422",		"data": [{			"context": "上海分拨中心/装件入车扫描 ",			"time": "2012-08-28 16:33:19",			"ftime": "2012-08-28 16:33:19",			"status": "在途",			"areaCode": "310000000000",			"areaName": "上海市"		}, {			"context": "上海分拨中心/下车扫描 ",			"time": "2012-08-27 23:22:42",			"ftime": "2012-08-27 23:22:42",			"status": "在途",			"areaCode": "310000000000",			"areaName": "上海市"		}],		"routeInfo": {			"from": {				"number": "CN3100",				"name": "上海市"			},			"cur": {				"number": "CN6101",				"name": "陕西,西安市"			},			"to": {				"number": "CN6101",				"name": "陕西,西安市"			}		},		"isLoop": false,		"trailUrl": "https://api.kuaidi100.com/tools/map/bc80574d538262aecc897a469151f0e3",		"arrivalTime": "2020-12-19 12",		"totalTime": "2天1小时",		"remainTime": "1天2小时"	}}'
响应示例响应示例
{
    "result": true,
    "returnCode": "200",
    "message": "成功"
}

请求参数

Body 参数application/x-www-form-urlencoded
sign
string 
可选
订阅参数salt值不为空时,推送数据将包含该加密签名,加密方式:md5(param+salt)
param
string 
主体参数对象
必需
示例值:
{ "status": "polling", "billstatus": "got", "message": "", "autoCheck": "1", "comOld": "yuantong", "comNew": "ems", "lastResult": { "message": "ok", "state": "0", "status": "200", "condition": "F00", "ischeck": "0", "com": "yuantong", "nu": "V030344422", "data": [{ "context": "上海分拨中心/装件入车扫描 ", "time": "2012-08-28 16:33:19", "ftime": "2012-08-28 16:33:19", "status": "在途", "areaCode": "310000000000", "areaName": "上海市" }, { "context": "上海分拨中心/下车扫描 ", "time": "2012-08-27 23:22:42", "ftime": "2012-08-27 23:22:42", "status": "在途", "areaCode": "310000000000", "areaName": "上海市" }], "routeInfo": { "from": { "number": "CN3100", "name": "上海市" }, "cur": { "number": "CN6101", "name": "陕西,西安市" }, "to": { "number": "CN6101", "name": "陕西,西安市" } }, "isLoop": false, "trailUrl": "https://api.kuaidi100.com/tools/map/bc80574d538262aecc897a469151f0e3", "arrivalTime": "2020-12-19 12", "totalTime": "2天1小时", "remainTime": "1天2小时" }}

返回响应

🟢200成功
application/json
Body
result
boolean 
必需
returnCode
string 
必需
message
string 
必需

【快递100】API开发者 微信交流群

用微信扫右侧二维码,加入【快递100】API开发者 交流群,互助沟通

扫码加入交流群
上一页
订阅接口
下一页
产品介绍
Built with