快递鸟一次性对接2000+物流接口

API服务
首页>API服务>在途监控API

API组件列表
下单类接口
电子面单API
上门取件API
预约取件API
查询类接口
即时查询API
物流跟踪API
在途监控APIAlternate Text
快递查询API
物流查询地图API
增值类接口
物流短信API
单号识别API
智能地址解析API
首页 > API文档 > 在途监控API
在途监控API
申请API
提供物流订单监控服务，用户可将订单内容通过订阅接口订阅到快递鸟，快递鸟对订单进行实时监控，当物流轨迹有更新时，实时获取数据，对数据进行格式化，计算运单预计到达时间、全流程的物流状态（无轨迹、已揽收、在途中、已签收、问题件、到达派件城市、派件中、快递柜或驿站签收、超时未更新、超时为签收、拒签/退件）、当前所在城市等数据后，推送给用户，监控直到订单签收后结束。也可以通过即时查询接口，即时获取订单的当前的实时状态。
应用场景功能说明使用流程API参数接入流程demo下载
应用场景
（1）电商平台物流查询模块，供用户查询订单当前的物流状态
（2）电商、ERP后台的物流监控系统，客服在对账前查询所有运单的签收状态，并追踪问题
（3）电商、ERP后台实时预警模块，对各种问题件进行实时监控处理
（4）电商、ERP后台获取物流状态后，可结合其他服务进行使用，如通知短信、APP通知推送
（5）APP、公众号、网址等物流查询模块，供用户输入单号实时查询物流状态
功能说明
使用流程
API参数
一、接口描述/说明
1.即时查询(增值版)接口
（1）查询接口支持按照运单号查询(单个查询)。
（2）接口需要指定快递单号的快递公司编码，格式不对或则编码错误都会返失败的信息。
如：EMS物流单号应选择快递公司编码（EMS）查看快递公司编码
（3）返回的物流跟踪信息按照发生的时间升序排列。
（4）接口指令8001。
（5）接口支持的消息接收方式为HTTP POST，请求方法的编码格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8"。
（6）接口地址： API测试地址：http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址：https://api.kdniao.com/Ebusiness/EbusinessOrderHandle.aspx

请求系统级参数说明：
参数名称类型说明必须要求
RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式，须和DataType一致。是
EBusinessIDString商户ID，请在我的服务页面查看。是
RequestTypeString请求指令类型：8001是
DataSignString数据内容签名：把(请求内容(未编码)+AppKey)进行MD5加密，然后Base64编码，最后 进行URL(utf-8)编码。详细过程请查看Demo。是
DataTypeString请求、返回数据类型：2-json；否
2.订阅(增值版)接口
（1）此功能为专业定制，为特殊商户提供订阅服务，快递鸟系统会定时推送新的物流信息到商户系统。
（2）订阅快递号需指定相应的快递公司编码，格式不对或则编码错误都会返失败的信息。
如：EMS物流单号应选择快递公司编码（EMS）查看快递公司编码
（3）接口支持的消息接收方式为HTTP POST，请求方法的编码格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8"。
（4）接口地址： API测试地址：http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址：https://api.kdniao.com/api/dist
请求系统级参数说明：
参数名称类型说明必须要求
RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式，须和DataType一致。是
EBusinessIDString商户ID，请在我的服务页面查看。是
RequestTypeString请求指令类型：8008是
DataSignString数据内容签名：把(请求内容(未编码)+AppKey)进行MD5加密，然后Base64编码，最后 进行URL(utf-8)编码。详细过程请查看Demo。是
DataTypeString请求、返回数据类型：2-json；否
3.推送(增值版)接口(商户实现)
（1）客户需要按快递鸟要求开发接口，保证信息的正常接收。
（2）快递鸟主动推送时，物流信息接收接口由客户提供。
（3）接口支持的消息接收方式为HTTP POST，请求方法的编码格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8"。
（4）运单物流信息全量推送(每次推送的运单物流信息包括运单当前所有的的物流信息)。
请求系统级参数说明：
参数名称类型说明必须要求
RequestDataString请求内容需进行URL(utf-8)编码。请求内容只支持JSON格式。是
EBusinessIDString102-轨迹查询结果, 107-货款状态。是
二、接口参数
1.即时查询(增值版)接口
请求内容字段定义：
参数名称类型说明必须要求
OrderCodeString订单编号否
ShipperCodeString快递公司编码是
LogisticCodeString物流单号是
返回参数定义：
参数名称类型说明必须要求
EBusinessIDString用户ID是
OrderCodeString订单编号否
ShipperCodeString快递公司编码是
LogisticCodeString物流运单号否
SuccessBool成功与否是
ReasonString失败原因否
StateString物流状态：2-在途中,3-签收,4-问题件是
StateExString增值物流状态： 1-已揽收， 2-在途中， 201-到达派件城市， 202-派件中， 211-已放入快递柜或驿站， 3-已签收， 311-已取出快递柜或驿站， 4-问题件， 401-发货无信息， 402-超时未签收， 403-超时未更新， 404-拒收（退件）， 412-快递柜或驿站超时未取是
LocationString增值所在城市是
Traces
AcceptTimeString时间是
AcceptStationString描述是
LocationString当前城市否
ActionString当前状态否
RemarkString备注否
2.订阅(增值版)接口
请求内容字段定义：
参数名称类型说明必须要求
CallbackString用户自定义回调信息。否
MemberIDString会员标识。否
WareHouseIDString仓库标识否
CustomerNameString电子面单客户号否
CustomerPwdString电子面单密码否
SendSiteString收件网点标识(名称)否
ShipperCodeString快递公司编码 详细编码参考《快递鸟接口支持快递公司编码.xlsx》是
LogisticCodeString快递单号是
OrderCodeString订单编号否
MonthCodeString月结编号否
PayTypeInt(1)运费支付方式： 1-现付，2-到付，3-月结，4-第三方支付否
ExpTypeString(2)快递类型：1-标准快件 详细快递类型参考《快递公司快递业务类型.xlsx》否
CostDouble快递运费否
OtherCostDouble快递运费否
ReceiverCompanyString收件人公司否
NameString收件人是
TelString电话与手机，必填一个是
MobileString
PostCodeString收件地邮编(ShipperCode为EMS、YZPY时必填)否
ProvinceNameString收件省 (如广东省，不要缺少“省”；如是直辖市，请直接传北京、上海等； 如是自治区，请直接传广西壮族自治区等)是
CityNameString收件市(如深圳市，不要缺少“市”)是
ExpAreaNameString收件区/县(如福田区，不要缺少“区”或“县”)是
AddressString收件人详细地址是
SenderCompanyString发件人公司否
NameString发件人是
TelString电话与手机，必填一个是
MobileString
PostCodeString发件地邮编(ShipperCode为EMS、YZPY时必填)否
ProvinceNameString发件省 (如广东省，不要缺少“省”； 如是直辖市，请直接传北京、上海等； 如是自治区，请直接传广西壮族自治区等)是
CityNameString发件市(如深圳市，不要缺少“市”)是
ExpAreaNameString发件区/县(如福田区，不要缺少“区”或“县”)是
AddressString发件人详细地址是
IsNoticeInt(1)是否通知快递员上门揽件：0-通知；1-不通知；不填则否
StartDateString上门揽件时间段，格式：YYYY-MM-DD HH24:MM:SS否
EndDateString否
WeightDouble月结编号否
MonthCodeString包裹总重量kg否
QuantityInt(2)包裹数，一个包裹对应一个运单号，如果是大于1个包裹，返回则按照子母件的方式返回母运单号和子运单号否
VolumeDouble包裹总体积m3否
RemarkString备注否
IsSendMessageInt(1)是否订阅短信： 0-不需要；1-需要否
AddServiceNameString增值服务名称否
ValueString增值服务值否
CustomerIDString客户标识否
CommodityGoodsNameString商品名称否
GoodsCodeString商品编码否
GoodsquantityInt(5)商品件数否
GoodsPriceString商品价格否
GoodsWeightString商品重量kg否
GoodsDescString商品描述否
GoodsVolDouble商品体积m3否
返回参数定义：
参数名称类型说明必须要求
EBusinessIDString用户ID是
UpdateTimeString时间是
SuccessBool成功与否：true，false是
ReasonString失败原因否
EstimatedDeliveryTimeString订单预计到货时间yyyy-mm-dd（即将上线）否
3.推送(增值版)接口
应用级输入参数
参数名称类型说明必须要求
EBusinessIDString用户电商ID是
PushTimeString推送时间是
CountString推送物流单号轨迹个数是
DataString推送物流单号轨迹集合是
订阅查询(增值版)结果（RequestType：102）
通过轨迹查询（订阅查询）接口订阅到快递鸟的数据，快递鸟推送时，会将推送的RequestType的值置为102，同时返回下列数据
请求内容字段定义:
参数类型说明必须要求
DataEBusinessIDString商户ID否
OrderCodeString订单编号否
ShipperCodeString快递公司编码是
LogisticCodeString快递单号R
SuccessBool成功与否：true,false是
ReasonString失败原因否
StateString物流状态: 0-无轨迹，1-已揽收，2-在途中 201-到达派件城市，3-签收,4-问题件是
StateExString增值物流状态： 1-已揽收， 2-在途中， 201-到达派件城市， 202-派件中， 211-已放入快递柜或驿站， 3-已签收， 311-已取出快递柜或驿站， 4-问题件， 401-发货无信息， 402-超时未签收， 403-超时未更新， 404-拒收（退件）， 412-快递柜或驿站超时未取是
LocationString增值所在城市是
CallBackString订阅接口的Bk值否
Traces
TraceAcceptTimeString时间是
AcceptStationString描述是
ActionString当前状态是
LocationString当前城市是
RemarkString备注否
EstimatedDeliveryTimeString预计到达时间yyyy-mm-dd否
PickerInfoPersonNameString快递员姓名否
PersonTelString快递员电话否
PersonCodeString快递员工号否
StationNameString网点名称否
StationAddressString网点地址否
StationTelString网点电话否
SenderInfoPersonNameString派件员姓名否
PersonTelString派件员电话否
PersonCodeString派件员工号否
StationNameString派件网点名称否
StationAddressString派件网点地址否
StationTelString派件网点电话否
返回参数定义
参数名称类型说明必须要求
EBusinessIDString用户ID是
UpdateTimeString时间是
SuccessBool成功与否：true，false是
ReasonString失败原因否
三、示例
即时查询(增值版)接口
请求示例 JSON
{
    "OrderCode": "",
    "ShipperCode": "QFKD",
    "LogisticCode": "390141793061"
}
返回示例 JSON
没有物流轨迹的{
    "EBusinessID":"1261585",
    "Traces":[],
    "OrderCode":"",
    "ShipperCode":"QFKD",
    "LogisticCode":"390141793061",
    "Success":false,
    "Reason":null
}有物流轨迹的{
    "EBusinessID":"1261585",
    "ShipperCode":"QFKD",
    "Success":true,
    "LogisticCode":"390141793061",
    "State":"3",
    "StateEx":"3",
    "Location":"威海市",
    "Traces":[
        {
            "AcceptTime":"2016-10-26 18:31:38",
            "AcceptStation":"【北京环铁站】的【互优图书】已收件",
            "Location":"北京市",
            "Action":"1"
        },
        {
            "AcceptTime":"2016-10-26 19:53:50",
            "AcceptStation":"快件在【北京环铁站】装车,正发往【北京分拨中心】",
            "Location":"北京市",
            "Action":"2"
        },
        {
            "AcceptTime":"2016-10-26 21:00:13",
            "AcceptStation":"快件到达【北京分拨中心】,上一站是【北京环铁站】",
            "Location":"北京市",
            "Action":"2"
        },
        {
            "AcceptTime":"2016-10-26 21:06:27",
            "AcceptStation":"快件在【北京分拨中心】装车,正发往【青州分拨中心】",
            "Location":"北京市",
            "Action":"2"
        },
        {
            "AcceptTime":"2016-10-27 11:04:43",
            "AcceptStation":"快件到达【北京分拨中心】,上一站是【】",
            "Location":"北京市",
            "Action":"2"
        },
        {
            "AcceptTime":"2016-10-27 13:04:43",
            "AcceptStation":"快件在【北京分拨中心】装车,正发往【青州分拨中心】",
            "Location":"北京市",
            "Action":"2"
        },
        {
            "AcceptTime":"2016-10-27 20:06:03",
            "AcceptStation":"快件到达【青州分拨中心】,上一站是【】",
            "Location":"潍坊市",
            "Action":"2"
        },
        {
            "AcceptTime":"2016-10-27 22:06:03",
            "AcceptStation":"快件在【青州分拨中心】装车,正发往【威海】",
            "Location":"潍坊市",
            "Action":"2"
        },
        {
            "AcceptTime":"2016-10-28 09:53:53",
            "AcceptStation":"快件到达【威海】,上一站是【青州分拨中心】",
            "Location":"威海市",
            "Action":"2"
        },
        {
            "AcceptTime":"2016-10-28 10:44:39",
            "AcceptStation":"快件到达【威海】,上一站是【青州分拨中心】",
            "Location":"威海市",
            "Action":"2"
        },
        {
            "AcceptTime":"2016-10-28 10:48:03",
            "AcceptStation":"【威海】的【王奕凯】正在派件",
            "Location":"威海市",
            "Action":"202"
        },
        {
            "AcceptTime":"2016-10-28 18:09:45",
            "AcceptStation":"已签收,签收人是【毕森】,签收网点是【威海】",
            "Location":"威海市",
            "Action":"3"
        }
    ]
}
订阅(增值版)接口
请求示例 JSON
{
    "ShipperCode":"SF",
    "OrderCode":"SF201608081055208281",
    "LogisticCode":"3100707578976",
    "PayType":"1",
    "ExpType":"1",
    "CustomerName":"",
    "CustomerPwd":"",
    "MonthCode":"",
    "IsNotice":"0",
    "Sender":{
        "Name":"1255760",
        "Tel":"",
        "Mobile":"13700000000",
        "ProvinceName":"广东省",
        "CityName":"深圳市",
        "ExpAreaName":"福田区",
        "Address":"测试地址"
    },
    "Receiver":{
        "Name":"1255760",
        "Tel":"",
        "Mobile":"13800000000",
        "ProvinceName":"广东省",
        "CityName":"深圳市",
        "ExpAreaName":"龙华新区",
        "Address":"测试地址2"
    },
    "Commodity":[
        {
            "GoodsName":"书本"
        }
    ]
}
返回示例 JSON
{
    "EBusinessID":"1151847",
    "UpdateTime":"2016-08-09 16:42:38",
    "Success":true,
    "Reason":""
}
推送接口(增值版)
请求示例 JSON[订阅查询(增值版)]
{
    "EBusinessID":"1261585",
    "Count":"1",
    "PushTime":"2016-11-03 11:54:34",
    "Data":[
        {
            "EBusinessID":"1261585",
            "ShipperCode":"ZTO",
            "LogisticCode":"416071867790",
            "Success":true,
            "State":"2",
            "Traces":[
                {
                    "AcceptTime":"2016-10-28 17:54:18",
                    "AcceptStation":"杭州钱江开发区 的 悠可1 已收件",
                    "Location":"杭州市",
                    "Action":"1"
                },
                {
                    "AcceptTime":"2016-10-28 19:10:59",
                    "AcceptStation":"快件离开 杭州钱江开发区 已发往 上海",
                    "Location":"杭州市",
                    "Action":"2"
                },
                {
                    "AcceptTime":"2016-10-28 21:49:34",
                    "AcceptStation":"快件已到达 杭州中转部",
                    "Location":"杭州市",
                    "Action":"2"
                },
                {
                    "AcceptTime":"2016-10-28 22:39:12",
                    "AcceptStation":"快件离开 杭州中转部 已发往 上海",
                    "Location":"杭州市",
                    "Action":"2"
                },
                {
                    "AcceptTime":"2016-10-29 02:07:53",
                    "AcceptStation":"快件已到达 上海航空部",
                    "Location":"上海市",
                    "Action":"2"
                },
                {
                    "AcceptTime":"2016-10-29 02:36:04",
                    "AcceptStation":"快件离开 上海 已发往 杨浦同济",
                    "Location":"上海市",
                    "Action":"2"
                },
                {
                    "AcceptTime":"2016-10-29 03:28:29",
                    "AcceptStation":"快件已到达 上海",
                    "Location":"上海市",
                    "Action":"2"
                },
                {
                    "AcceptTime":"2016-10-29 07:25:46",
                    "AcceptStation":"快件已到达 杨浦同济",
                    "Location":"上海市",
                    "Action":"2"
                },
                {
                    "AcceptTime":"2016-10-29 07:27:02",
                    "AcceptStation":"杨浦同济 的 近邻宝 正在派件",
                    "Location":"上海市",
                    "Action":"402"
                }
            ],
            "StateEx":"402",
            "Location":"上海市"
        }
    ]
}
返回示例JSON
{
    "EBusinessID":"1151847",
    "UpdateTime":"2016-08-09 16:42:38",
    "Success":true,
    "Reason":""
}
接入流程
demo下载
接口接入技术文档
在途监控接口Demo工具.NET版
在途监控接口Demo工具.PHP版
在途监控接口Demo工具.JAVA版
在途监控接口Demo工具.PYTHON版
在途监控接口Demo工具.GO版
在途监控接口Demo工具.NODE.JS版

相关文档与更多帮助？

30万+
数十万客户的选择
5.8亿次+
日均处理物流数据次数
1450万+
日均千万订单数据处理
2000家+
支持全国2000+家物流商

热门产品

在途监控快递查询物流查询地图版电子面单物流管家SaaS管理工具企业寄件SaaS管理工具

解决方案

电商平台物流解决方案ISV系统商解决方案连锁门店发货解决方案商家打单发货解决方案退换货上门取件方案聚合寄件上门取件方案C2C上门取件方案国际物流查询解决方案

接口API

API接口文档快递鸟API接口DEMO下载

关于我们

公司介绍企业动态联系我们法律声明合作伙伴快递鸟接口服务协议用户隐私政策物流生态平台

友情链接

商派海淘转运FEC富润电商递易智能
咨询电话：400-8699-100服务邮箱：service@kdniao.com
微信公众号
微信订阅号
微信扫码寄件
版权所有：深圳市快金数据技术服务有限公司  粤ICP备15010928号-1增值电信业务许可证：合字B2-20230224粤公安备案号：44030402002993
技术对接x
扫码寄件x
在线咨询

Hi~ 我在线

欢迎您随时咨询
×
扫码查寄件
扫码寄件
技术对接
技术对接
试用开通