零售電商平台及ISV商家對物流api接口的需求有很多,今天我們主要分享的就是快遞鳥快遞單號查詢接口的對接指南,快遞單號查詢接口對接的應用場景有很多,很多場景會遇到,最主要的就是電商網站用戶打開“我的訂單”時調用此API顯示物流信息詳情,電商管理后台的物流系統,客服在對賬前查詢所有運單的簽收狀態,並追蹤問題,電商平台對商家物流管控,要求必須在多久快遞必須發出要看到攬件狀態,多久必須收到貨物看到簽收狀態,根據這些狀態對商家管控從而提高用戶的整體滿意度。
調用快遞鳥快遞單號查詢API接口,就能查詢到1600多家以上快遞公司單號從收件、運輸,到轉運中心,派送到簽收等各個環節的物流發貨狀態。快遞鳥api接口不區分開發語言,支持Java,C#,PHP,Python,ObjectC等開發語言的程序調用。下面具體講解實現過程:
對接使用流程
1、將快遞單號和快遞公司編碼發送給快遞鳥
2、快遞鳥根據單號和快遞公司查詢到物流軌跡狀態
3、快遞鳥將查詢到的物流軌跡狀態反饋給電商平台或ISV服務商
4、電商平台或ISV服務商接收數據並實時處理做數據展示或應用
接口描述說明
(1)查詢接口支持按照運單號查詢(單個查詢)。 (2)接口需要指定快遞單號的快遞公司編碼,格式不對或則編碼錯誤都會返失敗的信息。 如:EMS物流單號應選擇快遞公司編碼(EMS)查看下載快遞鳥快遞公司編碼(快遞鳥官網聯系我們的在線客服)(3)返回的物流跟蹤信息按照發生的時間升序排列。 (4)接口指令1002。 (5)接口支持的消息接收方式為HTTP POST,請求方法的編碼格式(utf-8):"
application/x-www-form-urlencoded;charset=utf-8"。 (6)測試調用地址:http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json (7)正式調用地址:http://api.kdniao.com/api/dist(8)快遞鳥官網地址:【快遞鳥API】-快遞單號查詢接口-快遞電子面單-全球物流數據服務商
(9)返回類型:JSON
(10)調試頁面:
http://kdniao.com/UserCenter/v2/SandBox/TrackQuery.aspx
(11)調試工具:去調試(使用快遞鳥賬號登錄)
請求系統級參數說明:
備注:R-必填(Required),O-可選(Optional),C-報文中該參數在一定條件下可選(Conditional)
【接口參數】
請求內容字段定義:
返回參數定義:
示例
請求示例 JSON
{
“OrderCode”: “”,
“ShipperCode”: “SF”,
“LogisticCode”: “118650888018”
}
返回示例 JSON
沒有物流軌跡的
{
“EBusinessID”: “1109259”,
“Traces”: [],
“OrderCode”: “”,
“ShipperCode”: “SF”,
“LogisticCode”: “118461988807”,
“Success”: false,
“Reason”: null
}
有物流軌跡的
{
“EBusinessID”: “1109259”,
“OrderCode”: “”,
“ShipperCode”: “SF”,
“LogisticCode”: “118461988807”,
“Success”: true,
“State”: 3,
“Reason”: null,
“Traces”: [
{
“AcceptTime”: “2021/06/25 08:05:37”,
“AcceptStation”: “正在派件…(派件人:鄧裕富,電話:18718866310)[深圳 市]”,
“Remark”: null
},
{
“AcceptTime”: “2021/06/25 04:01:28”,
“AcceptStation”: “快件在 深圳集散中心 ,准備送往下一站 深圳 [深圳市]”,
“Remark”: null
},
{
“AcceptTime”: “2021/06/25 01:41:06”,
“AcceptStation”: “快件在 深圳集散中心 [深圳市]”,
“Remark”: null
},
{
“AcceptTime”: “2021/06/24 20:18:58”,
“AcceptStation”: “已收件[深圳市]”,
“Remark”: null
},
{
“AcceptTime”: “2021/06/24 20:55:28”,
“AcceptStation”: “快件在 深圳 ,准備送往下一站 深圳集散中心 [深圳市]”,
“Remark”: null
},
{
“AcceptTime”: “2021/06/25 10:23:03”,
“AcceptStation”: “派件已簽收[深圳市]”,
“Remark”: null
},
{
“AcceptTime”: “2021/06/25 10:23:03”,
“AcceptStation”: “簽收人是:已簽收[深圳市]”,
“Remark”: null
}
]
}
前期准備工作
去快遞鳥官網免費注冊一個賬號,免費獲得一個apiKey(接口權限驗證需要),完成實名認證流程,訂購一個免費或付費套餐(也可找快遞鳥工作人員免費申請付費的接口測試聯調):快遞單號查詢接口_電子面單_APIKey授權申請–快遞鳥賬號注冊
快遞鳥技術開發文檔下載快遞鳥DEMO下載
注:登錄快遞鳥用戶管理后台后獲得用戶ID和APIKey對應各demo中的EBusinessID、AppKey。
小知識:EBusinessID跟APIKey是什么?EBusinessID跟APIKey您在快遞鳥網站注冊之后快遞鳥分配的密鑰(對應官網上的用戶ID和API key),用於保證應用來源的可靠性,避免應用偽造,被不法使用。
請求完整報文(示例)
RequestData=%7b%27OrderCode%27%3a%27%27%2c%27ShipperCode%27%3a%27JTSD%27%2c%27LogisticCode%27%3a%27jt0000052600488%27%7d&
EBusinessID=1264783&RequestType=1002&DataSign=MTYyMDU4NWQ2NmU1ZDI2MDEzNGE5YmVlM2YxYzEzMTM%3d&DataType=2
成功返回報文(示例)
{
“LogisticCode”: “JT0000052600488”,
“ShipperCode”: “JTSD”,
“Traces”: [
{
“AcceptStation”: “【蕪湖市】【蕪湖鏡湖網點】的鄧擁軍 17855364213已取件”,
“AcceptTime”: “2020-03-16 16:26:13”
},
{
“AcceptStation”: “【蕪湖市】【蕪湖鏡湖網點】的鄧擁軍 17855364213已取件”,
“AcceptTime”: “2020-03-16 16:41:33”
},
{
“AcceptStation”: “【蕪湖市】【蕪湖鏡湖網點】已收件”,
“AcceptTime”: “2020-03-16 17:39:21”
},
{
“AcceptStation”: “【蕪湖市】快件離開【蕪湖鏡湖網點】已發往【蕪湖轉運中心】”,
“AcceptTime”: “2020-03-16 17:40:27”
},
{
“AcceptStation”: “【蕪湖市】快件到達【蕪湖轉運中心】”,
“AcceptTime”: “2020-03-16 19:36:32”
},
{
“AcceptStation”: “【蕪湖市】快件離開【蕪湖轉運中心】已發往【合肥轉運中心】”,
“AcceptTime”: “2020-03-16 20:47:03”
},
{
“AcceptStation”: “【合肥市】快件到達【合肥轉運中心】”,
“AcceptTime”: “2020-03-16 23:40:10”
},
{
“AcceptStation”: “【合肥市】快件離開【合肥轉運中心】已發往【廣州花都轉運中心】”,
“AcceptTime”: “2020-03-17 00:10:48”
},
{
“AcceptStation”: “【廣州市】快件到達【廣州花都轉運中心】”,
“AcceptTime”: “2020-03-17 20:45:00”
},
{
“AcceptStation”: “【廣州市】快件離開【廣州花都轉運中心】已發往【深圳寶安轉運中心】”,
“AcceptTime”: “2020-03-18 00:17:55”
},
{
“AcceptStation”: “【深圳市】快件到達【深圳寶安轉運中心】”,
“AcceptTime”: “2020-03-18 03:00:17”
},
{
“AcceptStation”: “【深圳市】快件離開【深圳寶安轉運中心】已發往【深圳福田網點】”,
“AcceptTime”: “2020-03-18 04:44:39”
},
{
“AcceptStation”: “【深圳市】【深圳福田網點】的鄒俊林 17679495647正在派件”,
“AcceptTime”: “2020-03-18 08:10:09”
},
{
“AcceptStation”: “【深圳市】【深圳福田網點】的趙凱 15919817730正在派件”,
“AcceptTime”: “2020-03-18 09:55:19”
},
{
“AcceptStation”: “【深圳市】快件已簽收,簽收人是【代收】,如有疑問請聯系:15919817730,期待再次為您服務”,
“AcceptTime”: “2020-03-18 14:53:54”
}
],
“State”: “3”,
“EBusinessID”: “1264783”,
“Success”: true
}
失敗返回報文(示例)
{
“LogisticCode”: “JT0000052600488”,
“ShipperCode”: “JTSD”,
“Traces”: [],
“State”: “0”,
“EBusinessID”: “1264783”,
“Reason”: “業務錯誤[沒有可用套餐]”,
“Success”: false
}
說明:未實名認證,未訂購套餐,套餐可用查詢量已經用完 都會返回此報文信息去實名認證/ 了解套餐詳情
無軌跡返回報文(示例)
{
“LogisticCode”: “JT0000052600488”,
“ShipperCode”: “JTSD”,
“Traces”: [],
“State”: “0”,
“EBusinessID”: “1264783”,
“Reason”: “暫無軌跡信息”,
“Success”: true
}