• 全国空气质量公报:华中华北有利臭氧生成 2019-05-21
  • 炎炎夏日要怎么养生? 这些妙招不错! 2019-05-21
  • (Dos sesiones) Enfoque de China Presidente Xi promete servir al pueblo en clausura de sesión anual de APN Spanish.xinhuanet.com 2019-05-21
  • 重构城市体系——论中国区域和城市可持续发展战略 2019-05-20
  • 特朗普:晋三,送你2500万墨西哥移民,你立马下台 2019-05-20
  • 点赞!5名男子冰河接力救人 2个孩子成功获救 2019-05-19
  • 北京将为人才提供住房支持 ——凤凰网房产北京 2019-05-19
  • 人民日报社天津分社公开招聘工作人员公告 2019-05-19
  • 铜梁这位30岁小伙抱上吉他骑着摩托去北极过生! 2019-05-19
  • 法兰克福投“中国人所好”改造老城区 吸引游客来此“怀旧” 2019-05-18
  • 端午假期铁路迎来返程客流高峰 2019-05-18
  • 河北阜城:“粽情飘香”敬老院 2019-05-18
  • 揭秘劣质红木家具的惯用造假手段 2019-05-18
  • 曹鸿鸣:为国家经济社会发展发挥致公党应有作用 2019-05-17
  • 中央环保督察组约见南昌分管副市长 2019-05-17
  • 首页 > API文档 > 在途监控API
    在途监控API
    申请API
    提供物流订单监控服务,用户可将订单内容通过订阅接口订阅到快递鸟,快递鸟对订单进行实时监控,当物流轨迹有更新时,实时获取数据,对数据进行格式化,计算运单预计到达时间、全流程的物流状态(无轨迹、已揽收、在途中、已签收、问题件、到达派件城市、派件中、快递柜或驿站签收、超时未更新、超时为签收、拒签/退件)、当前所在城市等数据后,推送给用户,监控直到订单签收后结束。也可以通过即时查询接口,即时获取订单的当前的实时状态。
    应用场景
    (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测试地址://sandboxapi.www.ahgdo.tw:8080/kdniaosandbox/gateway/exterfaceInvoke.json
    API正式地址://api.kdniao.com/Ebusiness/EbusinessOrderHandle.aspx

    请求系统级参数说明:
    参数名称类型说明必须要求
    RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式,须和DataType一致。R
    EBusinessIDString商户ID,请在我的服务页面查看。R
    RequestTypeString请求指令类型:8001R
    DataSignString数据内容签名:把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码,最后 进行URL(utf-8)编码。详细过程请查看Demo。R
    DataTypeString请求、返回数据类型:2-json;O
    备注:R-必填(Required),O-可?。∣ptional),C-报文中该参数在一定条件下可?。–onditional)
    2.订阅(增值版)接口
    (1)此功能为专业定制,为特殊商户提供订阅服务,快递鸟系统会定时推送新的物流信息到商户系统。
    (2)订阅快递号需指定相应的快递公司编码,格式不对或则编码错误都会返失败的信息。
    如:EMS物流单号应选择快递公司编码(EMS)查看快递公司编码
    (3)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
    (4)接口地址: API测试地址://sandboxapi.www.ahgdo.tw:8080/kdniaosandbox/gateway/exterfaceInvoke.json
    API正式地址://api.kdniao.com/api/dist
    请求系统级参数说明:
    参数名称类型说明必须要求
    RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式,须和DataType一致。R
    EBusinessIDString商户ID,请在我的服务页面查看。R
    RequestTypeString请求指令类型:8008R
    DataSignString数据内容签名:把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码,最后 进行URL(utf-8)编码。详细过程请查看Demo。R
    DataTypeString请求、返回数据类型:2-json;O
    备注:R-必填(Required),O-可?。∣ptional),C-报文中该参数在一定条件下可?。–onditional)
    3.推送(增值版)接口(商户实现)
    (1)客户需要按快递鸟要求开发接口,保证信息的正常接收。
    (2)快递鸟主动推送时,物流信息接收接口由客户提供。
    (3)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
    (4)运单物流信息全量推送(每次推送的运单物流信息包括运单当前所有的的物流信息)。
    请求系统级参数说明:
    参数名称类型说明必须要求
    RequestDataString请求内容需进行URL(utf-8)编码。请求内容只支持JSON格式。R
    EBusinessIDString102-轨迹查询结果, 107-货款状态。R
    备注:R-必填(Required),O-可?。∣ptional),C-报文中该参数在一定条件下可?。–onditional)
    二、接口参数
    1.即时查询(增值版)接口
    请求内容字段定义:
    参数名称类型说明必须要求
    OrderCodeString订单编号O
    ShipperCodeString快递公司编码R
    LogisticCodeString物流单号R
    返回参数定义:
    参数名称类型说明必须要求
    EBusinessIDString用户IDR
    OrderCodeString订单编号O
    ShipperCodeString快递公司编码R
    LogisticCodeString物流运单号O
    SuccessBool成功与否R
    ReasonString失败原因O
    StateString物流状态:2-在途中,3-签收,4-问题件R
    StateExString增值物流状态: 1-已揽收, 2-在途中, 201-到达派件城市, 202-派件中, 211-已放入快递柜或驿站, 3-已签收, 311-已取出快递柜或驿站, 4-问题件, 401-发货无信息, 402-超时未签收, 403-超时未更新, 404-拒收(退件), 412-快递柜或驿站超时未取R
    LocationString增值所在城市R
    Traces
    AcceptTimeString时间R
    AcceptStationString描述R
    LocationString当前城市O
    ActionString当前状态O
    RemarkString备注O
    2.订阅(增值版)接口
    请求内容字段定义:
    参数名称类型说明必须要求
    CallbackString用户自定义回调信息。O
    MemberIDString会员标识。O
    WareHouseIDString仓库标识O
    CustomerNameString电子面单客户号O
    CustomerPwdString电子面单密码O
    SendSiteString收件网点标识(名称)O
    ShipperCodeString快递公司编码 详细编码参考《2019快递鸟接口支持快递公司编码.xlsx》R
    LogisticCodeString快递单号R
    OrderCodeString订单编号O
    MonthCodeString月结编号O
    PayTypeInt(1)运费支付方式: 1-现付,2-到付,3-月结,4-第三方支付O
    ExpTypeString(2)快递类型:1-标准快件 详细快递类型参考《快递公司快递业务类型.xlsx》O
    CostDouble快递运费O
    OtherCostDouble快递运费O
    ReceiverCompanyString收件人公司O
    NameString收件人R
    TelString电话与手机,必填一个R
    MobileString
    PostCodeString收件地邮编(ShipperCode为EMS、YZPY时必填)O
    ProvinceNameString收件省 (如广东省,不要缺少“省”;如是直辖市,请直接传北京、上海等; 如是自治区,请直接传广西壮族自治区等)R
    CityNameString收件市(如深圳市,不要缺少“市”)R
    ExpAreaNameString收件区/县(如福田区,不要缺少“区”或“县”)R
    AddressString收件人详细地址R
    SenderCompanyString发件人公司O
    NameString发件人R
    TelString电话与手机,必填一个R
    MobileString
    PostCodeString发件地邮编(ShipperCode为EMS、YZPY时必填)O
    ProvinceNameString发件省 (如广东省,不要缺少“省”; 如是直辖市,请直接传北京、上海等; 如是自治区,请直接传广西壮族自治区等)R
    CityNameString发件市(如深圳市,不要缺少“市”)R
    ExpAreaNameString发件区/县(如福田区,不要缺少“区”或“县”)R
    AddressString发件人详细地址R
    IsNoticeInt(1)是否通知快递员上门揽件:0-通知;1-不通知;不填则O
    StartDateString上门揽件时间段,格式:YYYY-MM-DD HH24:MM:SSO
    EndDateStringO
    WeightDouble月结编号O
    MonthCodeString包裹总重量kgO
    QuantityInt(2)包裹数,一个包裹对应一个运单号,如果是大于1个包裹,返回则按照子母件的方式返回母运单号和子运单号O
    VolumeDouble包裹总体积m3O
    RemarkString备注O
    IsSendMessageInt(1)是否订阅短信: 0-不需要;1-需要O
    AddServiceNameString增值服务名称O
    ValueString增值服务值O
    CustomerIDString客户标识O
    CommodityGoodsNameString商品名称O
    GoodsCodeString商品编码O
    GoodsquantityInt(5)商品件数O
    GoodsPriceString商品价格O
    GoodsWeightString商品重量kgO
    GoodsDescString商品描述O
    GoodsVolDouble商品体积m3O
    返回参数定义:
    参数名称类型说明必须要求
    EBusinessIDString用户IDR
    UpdateTimeString时间R
    SuccessBool成功与否:true,falseR
    ReasonString失败原因O
    EstimatedDeliveryTimeString订单预计到货时间yyyy-mm-dd(即将上线)O
    3.推送(增值版)接口
    应用级输入参数
    参数名称类型说明必须要求
    EBusinessIDString用户电商IDR
    PushTimeString推送时间R
    CountString推送物流单号轨迹个数R
    DataString推送物流单号轨迹集合R
    订阅查询(增值版)结果(RequestType:102)
    通过轨迹查询(订阅查询)接口订阅到快递鸟的数据,快递鸟推送时,会将推送的RequestType的值置为102,同时返回下列数据
    请求内容字段定义:
    参数类型说明必须要求
    DataEBusinessIDString商户IDO
    OrderCodeString订单编号O
    ShipperCodeString快递公司编码R
    LogisticCodeString快递单号R
    SuccessBool成功与否:true,falseR
    ReasonString失败原因O
    StateString物流状态: 0-无轨迹,1-已揽收,2-在途中 201-到达派件城市,3-签收,4-问题件R
    StateExString增值物流状态: 1-已揽收, 2-在途中, 201-到达派件城市, 202-派件中, 211-已放入快递柜或驿站, 3-已签收, 311-已取出快递柜或驿站, 4-问题件, 401-发货无信息, 402-超时未签收, 403-超时未更新, 404-拒收(退件), 412-快递柜或驿站超时未取R
    LocationString增值所在城市R
    CallBackString订阅接口的Bk值O
    Traces
    TraceAcceptTimeString时间R
    AcceptStationString描述R
    ActionString当前状态R
    LocationString当前城市R
    RemarkString备注O
    EstimatedDeliveryTimeString预计到达时间yyyy-mm-ddO
    PickerInfoPersonNameString快递员姓名O
    PersonTelString快递员电话O
    PersonCodeString快递员工号O
    StationNameString网点名称O
    StationAddressString网点地址O
    StationTelString网点电话O
    SenderInfoPersonNameString派件员姓名O
    PersonTelString派件员电话O
    PersonCodeString派件员工号O
    StationNameString派件网点名称O
    StationAddressString派件网点地址O
    StationTelString派件网点电话O
    返回参数定义
    参数名称类型说明必须要求
    EBusinessIDString用户IDR
    UpdateTimeString时间R
    SuccessBool成功与否:true,falseR
    ReasonString失败原因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家物流商
    在线咨询
    商务合作群:
    847086973
    技术对接群10:
    790953829
    分析港彩平特肖尾软件
    400-9633321
    免费获取API
  • 全国空气质量公报:华中华北有利臭氧生成 2019-05-21
  • 炎炎夏日要怎么养生? 这些妙招不错! 2019-05-21
  • (Dos sesiones) Enfoque de China Presidente Xi promete servir al pueblo en clausura de sesión anual de APN Spanish.xinhuanet.com 2019-05-21
  • 重构城市体系——论中国区域和城市可持续发展战略 2019-05-20
  • 特朗普:晋三,送你2500万墨西哥移民,你立马下台 2019-05-20
  • 点赞!5名男子冰河接力救人 2个孩子成功获救 2019-05-19
  • 北京将为人才提供住房支持 ——凤凰网房产北京 2019-05-19
  • 人民日报社天津分社公开招聘工作人员公告 2019-05-19
  • 铜梁这位30岁小伙抱上吉他骑着摩托去北极过生! 2019-05-19
  • 法兰克福投“中国人所好”改造老城区 吸引游客来此“怀旧” 2019-05-18
  • 端午假期铁路迎来返程客流高峰 2019-05-18
  • 河北阜城:“粽情飘香”敬老院 2019-05-18
  • 揭秘劣质红木家具的惯用造假手段 2019-05-18
  • 曹鸿鸣:为国家经济社会发展发挥致公党应有作用 2019-05-17
  • 中央环保督察组约见南昌分管副市长 2019-05-17