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

API服務

預約取件API

首頁 > API文檔 > 在途監控API

在途監控API

申請API

提供物流訂單監控服務，用戶可將訂單內容通過訂閱接口訂閱到快遞鳥，快遞鳥對訂單進行實時監控，當物流軌跡有更新時，實時獲取數據，對數據進行格式化，計算運單預計到達時間、全流程的物流狀態（無軌跡、已攬收、在途中、已簽收、問題件、到達派件城市、派件中、快遞柜或驛站簽收、超時未更新、超時為簽收、拒簽/退件）、當前所在城市等數據后，推送給用戶，監控直到訂單簽收后結束。也可以通過即時查詢接口，即時獲取訂單的當前的實時狀態。

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

應用場景

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

請求系統級參數說明：

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

2.訂閱(增值版)接口

（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	請求指令類型：8008	是
DataSign	String	數據內容簽名：把(請求內容(未編碼)+AppKey)進行MD5加密，然后Base64編碼，最后進行URL(utf-8)編碼。詳細過程請查看Demo。	是
DataType	String	請求、返回數據類型：2-json；	否

3.推送(增值版)接口(商戶實現)

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

請求系統級參數說明：

參數名稱	類型	說明	必須要求
RequestData	String	請求內容需進行URL(utf-8)編碼。請求內容只支持JSON格式。	是
EBusinessID	String	102-軌跡查詢結果, 107-貨款狀態。	是

二、接口參數

1.即時查詢(增值版)接口

請求內容字段定義：

參數名稱	類型	說明	必須要求
OrderCode	String	訂單編號	否
ShipperCode	String	快遞公司編碼	是
LogisticCode	String	物流單號	是

返回參數定義：

參數名稱	類型	說明	必須要求
EBusinessID	String	用戶ID	是
OrderCode	String	訂單編號	否
ShipperCode	String	快遞公司編碼	是
LogisticCode	String	物流運單號	否
Success	Bool	成功與否	是
Reason	String	失敗原因	否
State	String	物流狀態：2-在途中,3-簽收,4-問題件	是
StateEx	String	增值物流狀態： 1-已攬收， 2-在途中， 201-到達派件城市， 202-派件中， 211-已放入快遞柜或驛站， 3-已簽收， 311-已取出快遞柜或驛站， 4-問題件， 401-發貨無信息， 402-超時未簽收， 403-超時未更新， 404-拒收（退件）， 412-快遞柜或驛站超時未取	是
Location	String	增值所在城市	是
Traces
AcceptTime	String	時間	是
AcceptStation	String	描述	是
Location	String	當前城市	否
Action	String	當前狀態	否
Remark	String	備注	否

2.訂閱(增值版)接口

請求內容字段定義：

參數名稱		類型	說明	必須要求
Callback		String	用戶自定義回調信息。	否
MemberID		String	會員標識。	否
WareHouseID		String	倉庫標識	否
CustomerName		String	電子面單客戶號	否
CustomerPwd		String	電子面單密碼	否
SendSite		String	收件網點標識(名稱)	否
ShipperCode		String	快遞公司編碼詳細編碼參考《快遞鳥接口支持快遞公司編碼.xlsx》	是
LogisticCode		String	快遞單號	是
OrderCode		String	訂單編號	否
MonthCode		String	月結編號	否
PayType		Int(1)	運費支付方式： 1-現付，2-到付，3-月結，4-第三方支付	否
ExpType		String(2)	快遞類型：1-標準快件詳細快遞類型參考《快遞公司快遞業務類型.xlsx》	否
Cost		Double	快遞運費	否
OtherCost		Double	快遞運費	否
Receiver	Company	String	收件人公司	否
	Name	String	收件人	是
	Tel	String	電話與手機，必填一個	是
	Mobile	String	電話與手機，必填一個	是
	PostCode	String	收件地郵編(ShipperCode為EMS、YZPY時必填)	否
	ProvinceName	String	收件省 (如廣東省，不要缺少“省”；如是直轄市，請直接傳北京、上海等；如是自治區，請直接傳廣西壯族自治區等)	是
	CityName	String	收件市(如深圳市，不要缺少“市”)	是
	ExpAreaName	String	收件區/縣(如福田區，不要缺少“區”或“縣”)	是
	Address	String	收件人詳細地址	是
Sender	Company	String	發件人公司	否
	Name	String	發件人	是
	Tel	String	電話與手機，必填一個	是
	Mobile	String	電話與手機，必填一個	是
	PostCode	String	發件地郵編(ShipperCode為EMS、YZPY時必填)	否
	ProvinceName	String	發件省 (如廣東省，不要缺少“省”；如是直轄市，請直接傳北京、上海等；如是自治區，請直接傳廣西壯族自治區等)	是
	CityName	String	發件市(如深圳市，不要缺少“市”)	是
	ExpAreaName	String	發件區/縣(如福田區，不要缺少“區”或“縣”)	是
	Address	String	發件人詳細地址	是
IsNotice		Int(1)	是否通知快遞員上門攬件：0-通知；1-不通知；不填則	否
StartDate		String	上門攬件時間段，格式：YYYY-MM-DD HH24:MM:SS	否
EndDate		String	上門攬件時間段，格式：YYYY-MM-DD HH24:MM:SS	否
Weight		Double	月結編號	否
MonthCode		String	包裹總重量kg	否
Quantity		Int(2)	包裹數，一個包裹對應一個運單號，如果是大于1個包裹，返回則按照子母件的方式返回母運單號和子運單號	否
Volume		Double	包裹總體積m3	否
Remark		String	備注	否
IsSendMessage		Int(1)	是否訂閱短信： 0-不需要；1-需要	否
AddService	Name	String	增值服務名稱	否
	Value	String	增值服務值	否
	CustomerID	String	客戶標識	否
Commodity	GoodsName	String	商品名稱	否
	GoodsCode	String	商品編碼	否
	Goodsquantity	Int(5)	商品件數	否
	GoodsPrice	String	商品價格	否
	GoodsWeight	String	商品重量kg	否
	GoodsDesc	String	商品描述	否
	GoodsVol	Double	商品體積m3	否

返回參數定義：

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

3.推送(增值版)接口

應用級輸入參數

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

訂閱查詢(增值版)結果（RequestType：102）

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

請求內容字段定義:

參數			類型	說明	必須要求
Data	EBusinessID		String	商戶ID	否
	OrderCode		String	訂單編號	否
	ShipperCode		String	快遞公司編碼	是
	LogisticCode		String	快遞單號	R
	Success		Bool	成功與否：true,false	是
	Reason		String	失敗原因	否
	State		String	物流狀態: 0-無軌跡，1-已攬收，2-在途中 201-到達派件城市，3-簽收,4-問題件	是
	StateEx		String	增值物流狀態： 1-已攬收， 2-在途中， 201-到達派件城市， 202-派件中， 211-已放入快遞柜或驛站， 3-已簽收， 311-已取出快遞柜或驛站， 4-問題件， 401-發貨無信息， 402-超時未簽收， 403-超時未更新， 404-拒收（退件）， 412-快遞柜或驛站超時未取	是
	Location		String	增值所在城市	是
	CallBack		String	訂閱接口的Bk值	否
	Traces
	Trace	AcceptTime	String	時間	是
		AcceptStation	String	描述	是
		Action	String	當前狀態	是
		Location	String	當前城市	是
		Remark	String	備注	否
	EstimatedDeliveryTime		String	預計到達時間yyyy-mm-dd	否
	PickerInfo	PersonName	String	快遞員姓名	否
		PersonTel	String	快遞員電話	否
		PersonCode	String	快遞員工號	否
		StationName	String	網點名稱	否
		StationAddress	String	網點地址	否
		StationTel	String	網點電話	否
	SenderInfo	PersonName	String	派件員姓名	否
		PersonTel	String	派件員電話	否
		PersonCode	String	派件員工號	否
		StationName	String	派件網點名稱	否
		StationAddress	String	派件網點地址	否
		StationTel	String	派件網點電話	否

返回參數定義

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

三、示例

即時查詢(增值版)接口

請求示例 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":"【威?！康摹就蹀葎P】正在派件",
            "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下載

在途監控接口Demo工具.NODE.JS版

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

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

相關文檔與更多幫助？

熱門產品

解決方案

接口API

關于我們

友情鏈接

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

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

相關文檔與更多幫助？

熱門產品

解決方案

接口API

關于我們

友情鏈接

相關文檔與更多幫助？