首頁 > API文檔 > 快遞查詢API
快遞查詢API,供小程序、APP、需實時返回物流軌跡信息即查即走,快遞查詢將提供輸入運單編號立即獲取物流最新軌跡,無需快遞編碼,自動識別物流公司,返回物流軌跡。
(1)在移動端APP、小程序上輸入框與查詢按鈕,實現即時物流信息查詢。
(2)在網頁上使用輸入框與查詢按鈕,實現即時物流信息查詢。
(3)主流快遞公司,無需傳快遞編碼,自動識別物流公司返回物流軌跡。
一、接口描述/説明
(1)查詢接口支持按照運單號查詢(單個查詢)。
(2)接口需要指定快遞單號,格式不對或則編碼錯誤都會返失敗的信息。主流13家不需要選擇快遞公司編碼,其他需要選擇快遞公司編碼,查看快遞公司編碼。
(3)返回的物流跟蹤信息按照發生的時間升序排列。
(4)接口指令8002。
(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 | 請求指令類型:8002 | 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 |
CustomerName | String | ShipperCode 為JD,必填,對應京東的青龍配送編碼,也叫商家編碼,格式:數字+字母+數字,9 位數字加一個字母,共10 位,舉例:001K123450;ShipperCode 為SF,且快遞單號非快遞鳥渠道返回時,必填,對應收件人/寄件人手機號後四位;ShipperCode 為SF,且快遞單號為快遞鳥渠道返回時,不填;ShipperCode 為其他快遞時,不填 | C |
ShipperCode | String | 快遞公司編碼 | O |
LogisticCode | String | 物流單號 | R |
返回參數定義:
參數名稱 | 類型 | 説明 | 必須要求 |
---|
EBusinessID | String | 用户ID | R |
OrderCode | String | 訂單編號 | O |
ShipperCode | String | 快遞公司編碼 | R |
LogisticCode | String | 物流運單號 | O |
Success | Bool | 成功與否 | R |
Reason | String | 失敗原因 | O |
State | String | 物流狀態:0-暫無軌跡信息,1-已攬收,2-在途中,3-簽收,4-問題件 | R |
StateEx | String | 增值物流狀態: 0-暫無軌跡信息 1-已攬收 2-在途中 201-到達派件城市, 202-派件中, 211-已放入快遞櫃或驛站, 3-已簽收 301-正常簽收, 302-派件異常後最終簽收, 304-代收簽收, 311-快遞櫃或驛站簽收, 4-問題件 401-發貨無信息, 402-超時未簽收, 403-超時未更新, 404-拒收(退件), 405-派件異常, 406-退貨簽收, 407-退貨未簽收, 412-快遞櫃或驛站超時未取 | R |
Location | String | 所在城市 | R |
Traces.AcceptTime | String | 時間 | R |
Traces.AcceptStation | String | 描述 | R |
Traces.Action | String | 當前狀態(同StateEx) | R |
Traces.Location | String | 所在城市 | R |
Traces.Remark | String | 備註 | O |
三、示例
{ "LogisticCode":"772004651594875" }
沒有物流軌跡的 { "LogisticCode":"7720046515948751", "Traces":[ ], "State":"0", "EBusinessID":"1470400", "Reason":"暫無軌跡信息", "Success":true } 有物流軌跡的 { "StateEx":"2", "LogisticCode":"3103630045838", "ShipperCode":"YD", "Traces":[ { "Action":"1", "AcceptStation":"【香港集運如何退換貨】廣東深圳公司中心分撥分部 已攬收", "AcceptTime":"2020-06-17 03:31:04", "Location":"深圳市" }, { "Action":"2", "AcceptStation":"【香港集運如何退換貨】已離開 廣東深圳公司中心分撥分部;發往 上海分撥中心", "AcceptTime":"2020-06-17 03:34:08", "Location":"深圳市" }, { "Action":"2", "AcceptStation":"【香港集運如何退換貨】廣東深圳公司 已攬收", "AcceptTime":"2020-06-17 03:37:46", "Location":"深圳市" }, { "Action":"2", "AcceptStation":"【香港集運如何退換貨】已到達 廣東深圳公司", "AcceptTime":"2020-06-17 08:02:33", "Location":"深圳市" }, { "Action":"2", "AcceptStation":"【香港集運如何退換貨】已離開 廣東深圳公司;發往 上海分撥中心", "AcceptTime":"2020-06-17 08:11:33", "Location":"深圳市" }, { "Action":"2", "AcceptStation":"【香港集運如何退換貨】廣東深圳公司福田區水圍站分部 已攬收", "AcceptTime":"2020-06-17 09:22:25", "Location":"深圳市" } ], "State":"2", "EBusinessID":"1470400", "Success":true, "Location":"深圳市" }