快递鸟物流跟踪API代码参数接入流程

171 阅读7分钟

物流追踪API提供物流订单监控服务,用户将订单内容订阅到快递鸟后,快递鸟对订单进行实时监控,当物流轨迹有更新时,实时获取数据,对数据进行格式化,计算运单预计到达时间、全流程的物流状态、当前所在城市等数据后,推送给用户。监控直到订单签收后结束。

应用场景

(1)电商网站用户打开“我的订单”时调用此API显示物流信息详情。
(2)电商管理后台的物流系统,客服在对账前查询所有运单的签收状态,并追踪问题。
(3)适用于日查询量>500次的网站和系统。

功能说明

使用流程

API参数

一、接口描述/说明

1.订阅接口

(1)此功能为专业定制,为特殊商户提供订阅服务,快递鸟系统会定时推送新的物流信息到商户系统。
(2)订阅快递号需指定相应的快递公司编码,格式不对或则编码错误都会返失败的信息。
如:EMS物流单号应选择快递公司编码(EMS)查看快递公司编码
(3)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(4)接口地址: API测试地址:sandboxapi.kdniao.com:8080/kdniaosandb…
API正式地址:api.kdniao.com/api/dist

请求系统级参数说明:

2.推送接口(商户实现)

(1)客户需要按快递鸟要求开发接口,保证信息的正常接收。
(2)快递鸟主动推送时,物流信息接收接口由客户提供。
(3)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(4)运单物流信息全量推送(每次推送的运单物流信息包括运单当前所有的的物流信息)。

请求系统级参数说明:

二、接口参数

1.订阅接口

请求内容字段定义:

返回参数定义:

2.推送接口

应用级输入参数

订阅查询结果(RequestType:101)

通过轨迹查询(订阅查询)接口订阅到快递鸟的数据,快递鸟推送时,会将推送的RequestType的值置为101,同时返回下列数据

请求内容字段定义:

货款状态(RequestType:107)

用户通过电子面单使用快递鸟货到付款等金融服务时,快递鸟会将该订单的金融状态通过接口推送给用户。

请求内容字段定义:

返回参数定义

三、示例

订阅接口

请求示例 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": "1109259",
        "Count": "2",
        "PushTime": "2015-3-11 16:21:06",
        "Data": [
            {
                "EBusinessID": "1109259",
                "OrderCode": "",
                "ShipperCode": "EMS",
                "LogisticCode": "5042260908504",
                "Success": true,
                "Reason": "",
                "State": "2",
                "CallBack": "0",
                "Traces": [
                    {
                        "AcceptTime": "2015-03-06 21:16:58",
                        "AcceptStation": "深圳市横岗速递营销部已收件,(揽投员姓名:钟定基;联系电话:)",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-07 14:25:00",
                        "AcceptStation": "离开深圳市 发往广州市",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-08 00:17:00",
                        "AcceptStation": "到达广东速递物流公司广航中心处理中心(经转)",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-08 01:15:00",
                        "AcceptStation": "离开广州市 发往北京市(经转)",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-09 09:01:00",
                        "AcceptStation": "到达北京黄村转运站处理中心(经转)",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-09 18:39:00",
                        "AcceptStation": "离开北京市 发往呼和浩特市(经转)",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-10 18:06:00",
                        "AcceptStation": "到达  呼和浩特市 处理中心",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-11 09:53:48",
                        "AcceptStation": "呼和浩特市邮政速递物流分公司金川揽投部安排投递(投递员姓名:安长虹;联系电话:18047140142)",
                        "Remark": ""
                    }
                ]
            },
            {
                "EBusinessID": "1109259",
                "OrderCode": "",
                "ShipperCode": "EMS",
                "LogisticCode": "5042260943004",
                "Success": true,
                "Reason": "",
                "State": "2",
                "CallBack": "0",
                "Traces": [
                    {
                        "AcceptTime": "2015-03-07 15:26:09",
                        "AcceptStation": "深圳市横岗速递营销部已收件,(揽投员姓名:周宏彪;联系电话:13689537568)",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-08 16:32:00",
                        "AcceptStation": "离开深圳市 发往广州市",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-09 00:58:00",
                        "AcceptStation": "到达广东速递物流公司广航中心处理中心(经转)",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-09 01:15:00",
                        "AcceptStation": "离开广州市 发往北京市(经转)",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-10 05:20:00",
                        "AcceptStation": "到达北京黄村转运站处理中心(经转)",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-10 11:59:00",
                        "AcceptStation": "离开北京市 发往廊坊市(经转)",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-10 14:23:00",
                        "AcceptStation": "到达廊坊市处理中心(经转)",
                        "Remark": ""
                    },
                    {
                        "AcceptTime": "2015-03-11 08:55:00",
                        "AcceptStation": "离开廊坊市 发往保定市(经转)",
                        "Remark": ""
                    }
                ]
            }
        ]
    }

请求示例 JSON格式 (货款状态)

{
              "EBusinessID": "1109259",
              "Count": "2",
              "PushTime": "2015-3-11 16:21:06",
              "Data": [
                  {
                      "EBusinessID": "1109259",
                      "OrderCode": "",
                      "ShipperCode": "EMS",
                      "LogisticCode": "5042260908504",
                      "Success": true,
                      "Reason": "",
                      "State": "2",
                      "CallBack": "0",
                      "OrderState":"1",
                      "AccountName":"张三",
                      "AccountTel":"13800000000",
                      "AccountNum":"0321"
                  },
                  {
                      "EBusinessID": "1109259",
                      "OrderCode": "",
                      "ShipperCode": "EMS",
                      "LogisticCode": "5042260908522",
                      "Success": true,
                      "Reason": "",
                      "State": "2",
                      "CallBack": "0",
                      "OrderState":"1",
                      "AccountName":"张三",
                      "AccountTel":"13800000011",
                      "AccountNum":"0321"
                  }
              ]
          }

返回示例 JSON

{
        "EBusinessID": "1151847",
        "UpdateTime": "2016-08-09 16:42:38",
        "Success": true,
        "Reason": ""
        }

接入流程