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

请求系统级参数说明:
参数名称 类型 说明 必须要求
RequestData String 请求内容需进行URL(utf-8)编码。请求内容JSON格式,须和DataType一致。 R
EBusinessID String 商户ID,请在我的服务页面查看。 R
RequestType String 请求指令类型:8001 R
DataSign String 数据内容签名:把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码,最后 进行URL(utf-8)编码。详细过程请查看Demo。 R
DataType String 请求、返回数据类型:2-json; O
备注:R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)
订阅(增值版)接口
(1)此功能为专业定制,为特殊商户提供订阅服务,快递鸟系统会定时推送新的物流信息到商户系统。
(2)订阅快递号需指定相应的快递公司编码,格式不对或则编码错误都会返失败的信息。
如:EMS物流单号应选择快递公司编码(EMS)查看快递公司编码
(3)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(4)接口地址: API测试地址:http://testapi.kdniao.cc:8081/api/dist
API正式地址:http://api.kdniao.cc/api/dist
请求系统级参数说明:
参数名称 类型 说明 必须要求
RequestData String 请求内容需进行URL(utf-8)编码。请求内容JSON格式,须和DataType一致。 R
EBusinessID String 商户ID,请在我的服务页面查看。 R
RequestType String 请求指令类型:8008 R
DataSign String 数据内容签名:把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码,最后 进行URL(utf-8)编码。详细过程请查看Demo。 R
DataType String 请求、返回数据类型:2-json; R
备注:R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)
推送(增值版)接口(商户实现)
(1)客户需要按快递鸟要求开发接口,保证信息的正常接收。
(2)快递鸟主动推送时,物流信息接收接口由客户提供。
(3)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(4)运单物流信息全量推送(每次推送的运单物流信息包括运单当前所有的的物流信息)。
请求系统级参数说明:
参数名称 类型 说明 必须要求
RequestData String 请求内容需进行URL(utf-8)编码。请求内容只支持JSON格式。 R
EBusinessID String 102-轨迹查询结果, 107-货款状态 R
备注:R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)
二、接口参数
即时查询(增值版)接口
请求内容字段定义:
参数名称 类型 说明 必须要求
OrderCode String 订单编号 O
ShipperCode String 快递公司编码 R
LogisticCode String 物流单号 R
返回参数定义:
参数名称 类型 说明 必须要求
EBusinessID String 用户ID R
OrderCode String 订单编号 O
ShipperCode String 快递公司编码 R
LogisticCode String 物流运单号 O
Success Bool 成功与否 R
Reason String 失败原因 O
State String 物流状态:2-在途中,3-签收,4-问题件 R
StateEx String 增值物流状态: 1-已揽收, 2-在途中, 201-到达派件城市, 202-派件中, 211-已放入快递柜或驿站, 3-已签收, 311-已取出快递柜或驿站, 4-问题件, 401-发货无信息, 402-超时未签收, 403-超时未更新, 404-拒收(退件), 412-快递柜或驿站超时未取 R
Location String 增值所在城市 R
Traces
AcceptTime String 时间 R
AcceptStation String 描述 R
Location String 当前城市 O
Action String 当前状态 O
Remark String 备注 O
订阅(增值版)接口
请求内容字段定义:
参数 类型 说明 必须要求
CallBack String 用户自定义回调信息 O
MemberID String 会员标识(备用字段) O
CustomerName String 电子面单客户账号(与快递网点申请) O
CustomerPwd String 电子面单密码 O
SendSite String 收件网点标识 O
ShipperCode String 快递公司编码 R
LogisticCode String 快递单号 R
OrderCode String 订单编号 O
MonthCode String 月结编码 O
PayType Int 邮费支付方式:1-现付,2-到付,3-月结,4-第三方支付 O
ExpType String 快递类型:1-标准快件 O
Cost Double 寄件费(运费) O
OtherCost Double 其他费用 O
Receiver Company String 收件人公司 O
Name String 收件人 O
Tel String 电话 O
Mobile String 手机 O
PostCode String 收件人邮编 O
ProvinceName String 收件省(如广东省,不要缺少“省”) O
CityName String 收件市(如深圳市,不要缺少“市”) O
ExpAreaName String 收件区(如福田区,不要缺少“区”或“县”) O
Address String 收件人详细地址 O
Sender Company String 发件人公司 O
Name String 发件人 O
Tel String 发件人电话 O
Mobile String 发件人手机 O
PostCode String 发件人邮编 O
ProvinceName String 发件省(如广东省,不要缺少“省”) O
CityName String 发件市(如深圳市,不要缺少“市”) O
ExpAreaName String 发件区(如福田区,不要缺少“区”或“县”) O
Address String 发件人详细地址 O
StartDate String 上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有时间格式相同 O
EndDate String O
Weight Double 物品总重量kg O
Quantity Int 件数/包裹数 O
Volume Double 物品总体积m3 O
Remark String 备注 O
IsNotice Int 是否分发到快递公司:1-不分发;0-分发.默认为0 O
AddService(数组形式)
AddService Name String 增值服务名称 O
Value String 增值服务值 O
CustomerID String 客户标识(选填) O
Commodity(数组形式)
Commodity GoodsName String 商品名称 O
GoodsCode String 商品编码 O
Goodsquantity Int 件数 O
GoodsPrice Double 商品价格 O
GoodsWeight Double 商品重量kg O
GoodsDesc String 商品描述 O
GoodsVol Double 商品体积m3 O
返回参数定义:
参数名称 类型 说明 必须要求
EBusinessID String 用户ID R
UpdateTime String 时间 R
Success Bool 成功与否:true,false R
Reason String 失败原因 O
EstimatedDeliveryTime String 订单预计到货时间yyyy-mm-dd(即将上线) O
推送(增值版)接口
应用级输入参数
参数名称 类型 说明 必须要求
EBusinessID String 用户电商ID R
PushTime String 推送时间 R
Count String 推送物流单号轨迹个数 R
Data String 推送物流单号轨迹集合 R
订阅查询(增值版)结果(RequestType:102)
通过轨迹查询(订阅查询)接口订阅到快递鸟的数据,快递鸟推送时,会将推送的RequestType的值置为102,同时返回下列数据
请求内容字段定义:
参数 类型 说明 必须要求
Data EBusinessID String 商户ID O
OrderCode String 订单编号 O
ShipperCode String 快递公司编码 R
LogisticCode String 快递单号 R
Success Bool 成功与否:true,false R
Reason String 失败原因 O
State String 物流状态: 0-无轨迹,1-已揽收,2-在途中 201-到达派件城市,3-签收,4-问题件 R
StateEx String 增值物流状态: 1-已揽收, 2-在途中, 201-到达派件城市, 202-派件中, 211-已放入快递柜或驿站, 3-已签收, 311-已取出快递柜或驿站, 4-问题件, 401-发货无信息, 402-超时未签收, 403-超时未更新, 404-拒收(退件), 412-快递柜或驿站超时未取 R
Location String 增值所在城市 R
CallBack String 订阅接口的Bk值 O
Traces
Trace AcceptTime String 时间 R
AcceptStation String 描述 R
Action String 当前状态 R
Location String 当前城市 R
Remark String 备注 O
EstimatedDeliveryTime String 预计到达时间yyyy-mm-dd O
PickerInfo PersonName String 快递员姓名 O
PersonTel String 快递员电话 O
PersonCode String 快递员工号 O
StationName String 网点名称 O
StationAddress String 网点地址 O
StationTel String 网点电话 O
SenderInfo PersonName String 派件员姓名 O
PersonTel String 派件员电话 O
PersonCode String 派件员工号 O
StationName String 派件网点名称 O
StationAddress String 派件网点地址 O
StationTel String 派件网点电话 O
返回参数定义
参数名称 类型 说明 必须要求
EBusinessID String 用户ID R
UpdateTime String 时间 R
Success Bool 成功与否:true,false R
Reason String 失败原因 O
三、示例
即时查询(增值版)接口
请求示例 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下载

相关文档与更多帮助?

30万+
数十万客户的选择
5.8亿次+
日均处理物流数据次数
1450万+
日均千万订单数据处理
418家+
支持全国418家物流商
在线咨询
商务合作群:
526574204
技术对接群:
620453345
400-9633321
免费获取API