首頁 > API文檔 > 即時查詢API
物流查詢API提供實時查詢物流軌跡的服務,用户提供運單號和快遞公司,即可查詢當前時刻的最新物流軌跡。
(1)電商網站用户打開“我的訂單”時調用此API顯示物流信息詳情。
(2)電商管理後台的物流系統,客服在對賬前查詢所有運單的簽收狀態,並追蹤問題。
(3)每日調用次數限制不超過500次,如超過該限制,請對接
物流跟蹤API。
(4)全流程的物流狀態跟蹤,即時查詢無限次,請對接
在途監控API一、接口描述/説明
(1)查詢接口支持按照運單號查詢(單個查詢)。
(2)接口需要指定快遞單號的快遞公司編碼,格式不對或則編碼錯誤都會返失敗的信息。
如:EMS物流單號應選擇快遞公司編碼(EMS)查看快遞公司編碼(3)返回的物流跟蹤信息按照發生的時間升序排列。
(4)接口指令1002。
(5)接口支持的消息接收方式為
HTTP POST,請求方法的編碼格式(utf-8):
"application/x-www-form-urlencoded;charset=utf-8"。
(6)測試地址://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
(7)正式地址://api.kdniao.com/Ebusiness/EbusinessOrderHandle.aspx
請求系統級參數説明:
參數名稱 | 類型 | 説明 | 必須要求 |
---|
RequestData | String | 請求內容需進行URL(utf-8)編碼。請求內容JSON格式,須和DataType一致。 | R |
EBusinessID | String | 商户ID,請在我的服務頁面查看。 | R |
RequestType | String | 請求指令類型:1002 | R |
DataSign | String | 數據內容簽名:把(請求內容(未編碼)+AppKey)進行MD5加密,然後Base64編碼,最後 進行URL(utf-8)編碼。詳細過程請查看Demo。 | R |
DataType | String | 請求、返回數據類型:2-json; | O |
備註:R-必填(Required),O-可選(Optional),C-報文中該參數在一定條件下可選(Conditional)
二、接口參數
請求內容字段定義:
參數名稱 | 類型 | 説明 | 必須要求 |
---|
OrderCode | String | 訂單編號 | O |
ShipperCode | String | 快遞公司編碼 | R |
LogisticCode | String | 物流單號 | R |
返回參數定義:
參數名稱 | 類型 | 説明 | 必須要求 |
---|
EBusinessID | String | 用户ID | R |
OrderCode | String | 訂單編號 | O |
ShipperCode | String | 快遞公司編碼 | R |
LogisticCode | String | 物流運單號 | O |
Success | Bool | 成功與否 | R |
Reason | String | 失敗原因 | O |
State | String | 物流狀態:2-在途中,3-簽收,4-問題件 | R |
Traces |
AcceptTime | String | 時間 | R |
AcceptStation | String | 描述 | R |
Remark | String | 備註 | O |
三、示例
{ "OrderCode": "", "ShipperCode": "SF", "LogisticCode": "118650888018" }
沒有物流軌跡的 { "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": "2014/06/25 08:05:37", "AcceptStation": "正在派件..(派件人:鄧裕富,電話:18718866310)[深圳 市]", "Remark": null }, { "AcceptTime": "2014/06/25 04:01:28", "AcceptStation": "快件在 深圳集散中心 ,準備送往下一站 深圳 [深圳市]", "Remark": null }, { "AcceptTime": "2014/06/25 01:41:06", "AcceptStation": "快件在 深圳集散中心 [深圳市]", "Remark": null }, { "AcceptTime": "2014/06/24 20:18:58", "AcceptStation": "已收件[深圳市]", "Remark": null }, { "AcceptTime": "2014/06/24 20:55:28", "AcceptStation": "快件在 深圳 ,準備送往下一站 深圳集散中心 [深圳市]", "Remark": null }, { "AcceptTime": "2014/06/25 10:23:03", "AcceptStation": "派件已簽收[深圳市]", "Remark": null }, { "AcceptTime": "2014/06/25 10:23:03", "AcceptStation": "簽收人是:已簽收[深圳市]", "Remark": null } ] }