快遞鳥一次性對接2000+物流接口

API服務

預約取件API

首頁 > API文檔 > 物流跟蹤API

物流跟蹤API

申請API

物流追蹤API提供物流訂單監控服務，用戶將訂單內容訂閱到快遞鳥后，快遞鳥對訂單進行實時監控，當物流軌跡有更新時，實時獲取數據，對數據進行格式化，計算運單預計到達時間、全流程的物流狀態、當前所在城市等數據后，推送給用戶。監控直到訂單簽收后結束。

應用場景功能說明使用流程 API參數接入流程 demo下載

應用場景

（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測試地址：http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址：https://api.kdniao.com/api/dist

請求系統級參數說明：

參數名稱	類型	說明	必須要求
RequestData	String	請求內容需進行URL(utf-8)編碼。請求內容JSON格式，須和DataType一致。	是
EBusinessID	String	商戶ID，請在我的服務頁面查看。	是
RequestType	String	請求指令類型：1008	是
DataSign	String	數據內容簽名：把(請求內容(未編碼)+AppKey)進行MD5加密，然后Base64編碼，最后進行URL(utf-8)編碼。詳細過程請查看Demo。	是
DataType	String	請求、返回數據類型：2-json；	是

2.推送接口(商戶實現)

（1）客戶需要按快遞鳥要求開發接口，保證信息的正常接收。
（2）快遞鳥主動推送時，物流信息接收接口由客戶提供。
（3）接口支持的消息接收方式為HTTP POST，請求方法的編碼格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8"。
（4）運單物流信息全量推送(每次推送的運單物流信息包括運單當前所有的的物流信息)。

請求系統級參數說明：

參數名稱	類型	說明	必須要求
RequestData	String	請求內容需進行URL(utf-8)編碼。請求內容只支持JSON格式。	是
RequestType	String	101-軌跡查詢結果, 107-貨款狀態	是
DataSign	String	數據內容簽名（把(請求內容(未編碼)+AppKey)進行MD5加密，然后Base64編碼）	是

二、接口參數

1.訂閱接口

請求內容字段定義：

參數		類型	說明	必須要求
Callback		String(50)	用戶自定義回調信息	否
MemberID		String(50)	會員標識(備用字段)	否
WareHouseID		String(30)	倉庫標識(備用字段)	否
CustomerName		String	電子面單客戶賬號(與快遞網點申請)	否
CustomerPwd		String	電子面單密碼	否
SendSite		String	收件網點標識(名稱)	否
ShipperCode		String(10)	快遞公司編碼	是
LogisticCode		String(30)	快遞單號	是
OrderCode		String(30)	訂單編號	否
MonthCode		String(20)	月結編號	否
PayType		Int	郵費支付方式:1-現付，2-到付，3-月結，4-第三方支付	否
ExpType		String(2)	快遞類型：1-標準快件	否
Cost		Double(5)	快遞運費	否
OtherCost		Double(5)	其他費用	否
Receiver	Company	String(30)	收件人公司	否
	Name	String(30)	收件人	是
	Tel	String(20)	電話(電話與手機，必填一個)	是
	Mobile	String(20)	手機	是
	PostCode	String(10)	收件人郵編	否
	ProvinceName	String(20)	收件省（如廣東省，不要缺少“省”）	是
	CityName	String(20)	收件市（如深圳市，不要缺少“市”）	是
	ExpAreaName	String(20)	收件區（如福田區，不要缺少“區”或“縣”）	是
	Address	String(100)	收件人詳細地址	是
Sender	Company	String(30)	發件人公司	否
	Name	String(30)	發件人	是
	Tel	String(20)	手機與電話必填一個	是
	Mobile	String(20)	發件人手機	是
	PostCode	String	發件人郵編	否
	ProvinceName	String(20)	發件省（如廣東省，不要缺少“省”）	是
	CityName	String(20)	發件市（如深圳市，不要缺少“市”）	是
	ExpAreaName	String(20)	發件區（如福田區，不要缺少“區”或“縣”）	是
	Address	String(100)	發件人詳細地址	是
IsNotice		Int(1)	是否通知快遞員上門攬件：0-通知;1-不通知;默認為1	否
StartDate		String	上門取貨時間段:"yyyy-MM-dd HH:mm:ss"格式化，本文中所有時間格式相同	否
EndDate		String	上門取貨時間段:"yyyy-MM-dd HH:mm:ss"格式化，本文中所有時間格式相同	否
Weight		Double	包裹總重量kg	否
Quantity		Int(2)	件數/包裹數	否
Volume		Double	物品總體積m3	否
Remark		String(60)	備注	否
IsSendMessage		Int(1)	是否訂閱短信：0-不需要；1-需要	否
AddService(數組形式)
AddService	Name	String(20)	增值服務名稱	否
	Value	String(30)	增值服務值	否
	CustomerID	String(30)	客戶標識(選填)	否
Commodity(數組形式)
Commodity	GoodsName	String(100)	商品名稱	否
	GoodsCode	String(20)	商品編碼	否
	Goodsquantity	Int(5)	件數	否
	GoodsPrice	Double(10)	商品價格	否
	GoodsWeight	Double	商品重量kg	否
	GoodsDesc	String(50)	商品描述	否
	GoodsVol	Double	商品體積m3	否

返回參數定義：

參數名稱	類型	說明	必須要求
EBusinessID	String	用戶ID	是
UpdateTime	String	更新時間 YYYY-MM-DD HH24:MM:SS	是
Success	Bool	成功與否：true，false	是
Reason	String(50)	失敗原因	否
EstimatedDeliveryTime	String	訂單預計到貨時間yyyy-mm-dd（即將上線）	否

2.推送接口

應用級輸入參數

參數名稱	類型	說明	必須要求
EBusinessID	String	用戶電商ID	是
PushTime	String	推送時間	是
Count	String	推送物流單號軌跡個數	是
Data	String	推送物流單號軌跡集合	是

訂閱查詢結果（RequestType：101）

通過軌跡查詢（訂閱查詢）接口訂閱到快遞鳥的數據，快遞鳥推送時，會將推送的RequestType的值置為101，同時返回下列數據

請求內容字段定義:

參數			類型	說明	必須要求
Data	EBusinessID		String	商戶ID	否
	ShipperCode		String	快遞公司編碼	是
	LogisticCode		String	快遞單號	R
	Success		Bool	成功與否：true,false	是
	Reason		String	失敗原因	否
	State		String	物流狀態: 0-無軌跡，1-已攬收，2-在途中，3-簽收,4-問題件	是
	CallBack		String	訂閱接口的Bk值	否
	Traces
	Traces	AcceptTime	String	時間	是
		AcceptStation	String	描述	是
		Remark	String	備注	否
	EstimatedDeliveryTime		String	預計到達時間yyyy-mm-dd	否

貨款狀態（RequestType：107）

用戶通過電子面單使用快遞鳥貨到付款等金融服務時，快遞鳥會將該訂單的金融狀態通過接口推送給用戶。

請求內容字段定義:

參數名稱		類型	說明	必須要求
Data	EBusinessID	String	用戶電商ID	否
	OrderCode	String	訂單編號	否
	ShipperCode	String	快遞公司編碼	是
	LogisticCode	String	物流運單號	是
	Success	Bool	成功與否	是
	Reason	String	失敗原因	否
	State	String	物流狀態:0-無軌跡,1-已攬收, 2-在途中 201-到達派件城市，3-簽收,4-問題件	是
	CallBack	String	訂閱接口的Bk值	否
	OrderState	String	訂單貨款狀態：1-待出款；2-已出款；3-已收款	否
	AccountName	String	返款銀行卡開戶人（例：*偉、佳）	否
	AccountTel	String	返款銀行卡手機末四位	否
	AccountNum	String	返款銀行卡末四位	否

返回參數定義

參數名稱	類型	說明	必須要求
EBusinessID	String	用戶ID	是
UpdateTime	String	時間	是
Success	Bool	成功與否：true，false	是
Reason	String	失敗原因	否

三、示例

訂閱接口

請求示例 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下載

接口接入技術文檔
物流跟蹤接口Demo工具.NET版

物流跟蹤接口Demo工具.NODE.JS版

欧美日韩无线在码不卡一区二区三区,免费国产不卡午夜福在线,国产在线欧美日韩一区二区,亚拍精品一区二区三区

快遞鳥一次性對接2000+物流接口

相關文檔與更多幫助？

熱門產品

解決方案

接口API

關于我們

友情鏈接