快遞接口api技術文檔-資料下載頁

【導讀】快遞接口技術文檔。2020-01-11對接口的說明進行了注釋，提高可讀性楊漢汶。2020-03-11新增批量訂閱推送接口，刪除版本推送接口楊文勝。2020-10-12新增訂單分發接口，整理電子面單接口曹強。2020-01-19重新調整在線下單接口曹強。2020-03-01增加智選物流接口曹強。2020-04-07推送接口更新任海洋。2020-05-11電子面單新增通知快遞員上門字段，推送接口新。C報文中該參數在一定條件下可選。本文檔目的是定義快遞鳥的通用對外服務接口，以便客戶接入快遞鳥API，從而打通客。戶與快遞鳥系統之間的信息流，實現整體物流信息化，進而達到快遞鳥與客戶的雙贏。

　　

【正文】 戶 )。 接口規則 (1)、 此功能只有部分物流公司支持，后續會支持更多物流公司的綁單 。 (2)、接口支持 Json/xml格式。 (3)、接口指令 1003。 系統級輸入參數 參數名稱 類型 必須要求 說明 RequestData String R 請求內容， JSON或 XML格式 ,須和DataType一致 EBusinessID String R 電商 ID RequestType String R 請求指令類型： 1003 DataSign String R 數據內容簽名 DataType String O 請求、返回數據類型： 1xml,2json；默認為 xml格式 應用級輸入參數 參數名稱 類型 必須要求 說明 OrderCode String R 訂單編號 ShipperCode String R 快遞公司編碼 LogisticCode String R 物流單號 快遞鳥 快遞接口技術文檔 23 / 51 返回 結果參數 參數名稱 類型 必須要求 說明 EBusinessID String R 電商用戶 ID OrderCode String R 訂單編號 ShipperCode String R 快遞公司編碼 LogisticCode String R 物流單號 Success Bool R 成功與否 Reason String O 失敗原因 XML 請求示例 Content OrderCode202006240002/OrderCode ShipperCodeZJS/ShipperCode LogisticCode109932607888/LogisticCode /Content JSON 請求示例 { OrderCode: 202006240002, ShipperCode: ZJS, LogisticCode: 118461988807 } XML 響應示例 Response EBusinessID1109259/EBusinessID OrderCode202006240002/OrderCode LogisticCode109932607888/LogisticCode Successtrue/Success Reason/Reason /Response 快遞鳥 快遞接口技術文檔 24 / 51 JSON 響應示例 { EBusinessID: 1109259, OrderCode: 202006240002, ShipperCode: ZJS, LogisticCode: 118461988807, Success: true, Reason: } 六 、運單訂閱 功能說明 此功能為專業定制，為特殊商戶提供訂閱服務，快遞鳥系統會定時推送新的物流信息到商戶系統 。 接口規則 (1)、支持 Json/xml格式。 (2)、請求指令 1005。 系統級輸入參數 參數名稱 類型 必須要求 說明 RequestData String R 請求內容， JSON或 XML格式 ,須和 DataType一致 EBusinessID String R 電商 ID RequestType String R 請求指令類型： 1005 DataSign String R 數據內容簽名 DataType String O 請求、返回數據類型： 1xml,2json；默認為 xml格式 快遞鳥 快遞接口技術文檔 25 / 51 應用級輸入參數 參數名稱 類型 必須要求 說明 Code String R 快遞公司編碼 Item String R 物流單號集合 參數名稱 類型 必須要求 說明 Item No String R 快遞物流單號 Bk String O 用戶標識 MemberID String O 會員標識 WarehouseID String O 倉庫標識 WarehouseAddress String O 倉庫地址 返回結果參數 參數名稱 類型 必須要求 說明 EBusinessID String R 電商用戶 ID UpdateTime String O 時間 Success String R 成功與否 :true,false Reason String 0 備注 JSON 請求示例 [ { Code: YTO, Item: [ { Bk: , No: 880143779586547836, MemberID: TB92578, WarehouseID: SZ86547836, WarehouseAddress: 皇崗 01 }, { Bk: , No: 880143779586547837 快遞鳥 快遞接口技術文檔 26 / 51 } ] }, { Code: SF, Item: [ { Bk: , No: 589871688930 }, { Bk: , No: 589871688931 } ] } ] JSON 返回示例 { EBusinessID: 1151847, UpdateTime: 20200313 16:42:38, Success: true, Reason: } 快遞鳥 快遞接口技術文檔 27 / 51 XML 請求示例 Content ExpressCodes CodeYD/Code Items Item No1901085671075/No Bk/Bk /Item Item No1000509345244/No Bk/Bk /Item /Items /ExpressCodes ExpressCodes CodeSF/Code Items Item No589707398027/No Bk/Bk /Item Item No589852819866/No Bk/Bk /Item /Items /ExpressCodes /Content XML 返回示例 Response EBusinessID1237100/EBusinessID UpdateTime2020/5/28 11:28:05/UpdateTime Successtrue/Success Reason / /Response 快遞鳥 快遞接口技術文檔 28 / 51 七 、推送接口 功能說明 客戶通過訂閱接口，把運單號在快遞鳥系統訂閱。運單物流信息有更新，快遞鳥通過推送接口把更新的信息推送給客戶。推送接口由用戶按照快遞鳥規則實現。 商戶開放接口，快遞鳥定時將最新的物流軌跡推送到商戶平臺。優點：客戶不需要關注軌跡變化，一旦有更新，快遞鳥自動推送。缺點：對客戶的服務器性能有所要求，快遞鳥定時請求接口，對客戶的服務器有一定的影響，客戶服務器異常將接受不到最新數據 。 接口規則 (1)、 客戶服務器必須穩定 ，并且有一定的接 受數據能力。快遞鳥通過多線程推送物流信息給客戶。 (2)、 客戶需要按快遞鳥要求開發接口，保證信息的正常接收 。客戶接數據后，存儲并馬上返回接收響應。如果客戶對數據進行處理，在再做出響應。這會造成網絡超時，傳輸效率地下。 (3)、 主動推送時物流信息接收接口由客戶提供 ，接口必須按照快遞鳥的要求實現。 (4)、 客戶提供接口地址 ，請聯系快遞鳥技術人員，聯系方式請求查看文檔尾頁。 (5)、接口只支持 Json 數據格式。 (6)、 POS 方式請求。 系統 級輸入參數 參數名稱 類型 必須要求 說明 RequestData String R 推送數據經 url轉碼 utf8 RequestType String R 1001分發結果 , 1005軌跡結果 ， 1007貨款狀態 應用級輸入參數 參數名稱 類型 必須要求 說明 EBusinessID String R 用戶電商 ID PushTime String R 推送時間 Count String R 推送物流單號軌跡個數 快遞鳥 快遞接口技術文檔 29 / 51 Data String R 推送物流單號軌跡集合 參數名稱 類型 必須要求 說明 Response EBusinessID String O 電商用戶 ID OrderCode String O 訂單編號 ShipperCode String R 快遞公司編碼 LogisticCode String R 物流運單號 Success Bool R 成功與否 Reason String O 失敗原因 State String R 物流狀態 : 2在途中 ， 3簽收 ,4問題件 CallBack String O 訂閱接口的 Bk值 Traces String R 物流軌跡 詳情 EstimatedDeliveryTime String O 預計到達時間yyyymmdd PickerInfo Object O 收件員信息 SenderInfo Object O 派件員信息 Location String O 當前所在省市 例：廣東省 ,深圳市 StateEx String O 增值服務物流狀態： 1已攬收 2在途中 201到達派件城市 211已放入 快遞柜 或驛站 3已簽收 311已取出快遞柜 或驛站 4問題件 401發貨無信息 402超時未簽收 403超時未更新 404拒收（退件） 412快遞柜或驛站超時未取 String O 訂單貨款 狀態： 1待出 快遞鳥 快遞接口技術文檔 30 / 51 款 ； 2已出款 ； 3已收款 String O 返款銀行卡開戶人（例：**偉、 *佳） String O 返款銀行卡手機末四位 String O 返款銀行卡末四位 注： 通過 訂單分發與電子面單接口自動訂閱的運單，會返回預計達到時間 ,收派件人員網點信息 ,當前快件所在省市等字段 參數名稱 類型 必須要求 說明 Traces AcceptTime String R 時間 AcceptStation String R 描述 Remark String O 備注 參數名稱