首頁 > API文檔 > 物流跟蹤API
物流跟蹤API
申請API
物流追蹤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.www.bcvon.club:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址://api.kdniao.com/api/dist
請求系統級參數說明:
參數名稱類型說明必須要求
RequestDataString請求內容需進行URL(utf-8)編碼。請求內容JSON格式,須和DataType一致。R
EBusinessIDString商戶ID,請在我的服務頁面查看。R
RequestTypeString請求指令類型:1008R
DataSignString數據內容簽名:把(請求內容(未編碼)+AppKey)進行MD5加密,然后Base64編碼,最后 進行URL(utf-8)編碼。詳細過程請查看Demo。R
DataTypeString請求、返回數據類型:2-json;R
備注:R-必填(Required),O-可?。∣ptional),C-報文中該參數在一定條件下可?。–onditional)
2.推送接口(商戶實現)
(1)客戶需要按快遞鳥要求開發接口,保證信息的正常接收。
(2)快遞鳥主動推送時,物流信息接收接口由客戶提供。
(3)接口支持的消息接收方式為HTTP POST,請求方法的編碼格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(4)運單物流信息全量推送(每次推送的運單物流信息包括運單當前所有的的物流信息)。
請求系統級參數說明:
參數名稱類型說明必須要求
RequestDataString請求內容需進行URL(utf-8)編碼。請求內容只支持JSON格式。R
RequestTypeString101-軌跡查詢結果, 107-貨款狀態R
DataSignString數據內容簽名(把(請求內容(未編碼)+AppKey)進行MD5加密,然后Base64編碼)R
備注:R-必填(Required),O-可?。∣ptional),C-報文中該參數在一定條件下可?。–onditional)
二、接口參數
1.訂閱接口
請求內容字段定義:
參數類型說明必須要求
CallbackString(50)用戶自定義回調信息O
MemberIDString(50)會員標識(備用字段)O
WareHouseIDString(30)倉庫標識(備用字段)O
CustomerNameString電子面單客戶賬號(與快遞網點申請)O
CustomerPwdString電子面單密碼O
SendSiteString收件網點標識(名稱)O
ShipperCodeString(10)快遞公司編碼R
LogisticCodeString(30)快遞單號R
OrderCodeString(30)訂單編號O
MonthCodeString(20)月結編號O
PayTypeInt郵費支付方式:1-現付,2-到付,3-月結,4-第三方支付O
ExpTypeString(2)快遞類型:1-標準快件O
CostDouble(5)快遞運費O
OtherCostDouble(5)其他費用O
ReceiverCompanyString(30)收件人公司O
NameString(30)收件人R
TelString(20)電話(電話與手機,必填一個)R
MobileString(20)手機R
PostCodeString(10)收件人郵編O
ProvinceNameString(20)收件?。ㄈ綣愣?,不要缺少“省”)R
CityNameString(20)收件市(如深圳市,不要缺少“市”)R
ExpAreaNameString(20)收件區(如福田區,不要缺少“區”或“縣”)R
AddressString(100)收件人詳細地址R
SenderCompanyString(30)發件人公司O
NameString(30)發件人R
TelString(20)手機與電話必填一個R
MobileString(20)發件人手機R
PostCodeString發件人郵編O
ProvinceNameString(20)發件?。ㄈ綣愣?,不要缺少“省”)R
CityNameString(20)發件市(如深圳市,不要缺少“市”)R
ExpAreaNameString(20)發件區(如福田區,不要缺少“區”或“縣”)R
AddressString(100)發件人詳細地址R
IsNoticeInt(1)是否通知快遞員上門攬件:0-通知;1-不通知;默認為1O
StartDateString上門取貨時間段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有時間格式相同O
EndDateStringO
WeightDouble包裹總重量kgO
QuantityInt(2)件數/包裹數O
VolumeDouble物品總體積m3O
RemarkString(60)備注O
IsSendMessageInt(1)是否訂閱短信:0-不需要;1-需要O
AddService(數組形式)
AddServiceNameString(20)增值服務名稱O
ValueString(30)增值服務值O
CustomerIDString(30)客戶標識(選填)O
Commodity(數組形式)
CommodityGoodsNameString(100)商品名稱O
GoodsCodeString(20)商品編碼O
GoodsquantityInt(5)件數O
GoodsPriceDouble(10)商品價格O
GoodsWeightDouble商品重量kgO
GoodsDescString(50)商品描述O
GoodsVolDouble商品體積m3O
返回參數定義:
參數名稱類型說明必須要求
EBusinessIDString用戶IDR
UpdateTimeString更新時間
YYYY-MM-DD HH24:MM:SS
R
SuccessBool成功與否:true,falseR
ReasonString(50)失敗原因O
EstimatedDeliveryTimeString訂單預計到貨時間yyyy-mm-dd(即將上線)O
2.推送接口
應用級輸入參數
參數名稱類型說明必須要求
EBusinessIDString用戶電商IDR
PushTimeString推送時間R
CountString推送物流單號軌跡個數R
DataString推送物流單號軌跡集合R
訂閱查詢結果(RequestType:101)
通過軌跡查詢(訂閱查詢)接口訂閱到快遞鳥的數據,快遞鳥推送時,會將推送的RequestType的值置為101,同時返回下列數據
請求內容字段定義:
參數類型說明必須要求
DataEBusinessIDString商戶IDO
ShipperCodeString快遞公司編碼R
LogisticCodeString快遞單號R
SuccessBool成功與否:true,falseR
ReasonString失敗原因O
StateString物流狀態: 0-無軌跡,1-已攬收,2-在途中,3-簽收,4-問題件R
CallBackString訂閱接口的Bk值O
Traces
TracesAcceptTimeString時間R
AcceptStationString描述R
RemarkString備注O
EstimatedDeliveryTimeString預計到達時間yyyy-mm-ddO
貨款狀態(RequestType:107)
用戶通過電子面單使用快遞鳥貨到付款等金融服務時,快遞鳥會將該訂單的金融狀態通過接口推送給用戶。
請求內容字段定義:
參數名稱類型說明必須要求
DataEBusinessIDString用戶電商IDO
OrderCodeString訂單編號O
ShipperCodeString快遞公司編碼R
LogisticCodeString物流運單號R
SuccessBool成功與否R
ReasonString失敗原因O
StateString物流狀態:0-無軌跡,1-已攬收, 2-在途中 201-到達派件城市,3-簽收,4-問題件R
CallBackString訂閱接口的Bk值O
OrderStateString訂單貨款狀態:1-待出款;2-已出款;3-已收款O
AccountNameString返款銀行卡開戶人(例:**偉、*佳)O
AccountTelString返款銀行卡手機末四位O
AccountNumString返款銀行卡末四位O
返回參數定義
參數名稱類型說明必須要求
EBusinessIDString用戶IDR
UpdateTimeString時間R
SuccessBool成功與否:true,falseR
ReasonString失敗原因O
三、示例
訂閱接口
請求示例 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": ""
        }
接入流程
demo下載

相關文檔與更多幫助?

30萬+
數十萬客戶的選擇
5.8億次+
日均處理物流數據次數
1450萬+
日均千萬訂單數據處理
600家+
支持全國600+家物流商
在線咨詢
商務合作群:
783245476
技術對接群14:
665031725
火箭vs鹈鹕
400-9633321
免費獲取API
黑龙江十一选五走势图表 开长租青年公寓赚钱吗 什么软件唱歌赚钱吗 100m上行 赚钱 钱宝网推广赚钱 极速十一选五现场开奖 手游馆赚钱吗 兑换货币赚钱合法吗 36棋牌游戏大厅下载手机版 早餐店买豆浆赚钱吗 139期快乐双彩开奖结果 双喜大厅群主 排列三走势图500期l 小鱼赚钱 青海11选5开奖走势图 滴滴跑车和易到怎么样赚钱