快遞鳥接口API技術(shù)文檔

1、快遞鳥接口(API)技術(shù)文檔版本日期版本說(shuō)明作者2014-12-013.0重新整理，根據(jù)功能分類，部分有調(diào)整楊文勝2014-01-113.1對(duì)接口的說(shuō)明進(jìn)行了注釋，提高可讀性楊漢汶2014-01-133.2新增推送接口楊漢汶2015-03-113.3新增批量訂閱推送接口，刪除3.2版本推送接口楊文勝2015-10-123.4新增訂單分發(fā)接口，整理電子面單接口曹強(qiáng)2016-01-193.5重新調(diào)整在線下單接口曹強(qiáng)2016-03-013.6增加智選物流接口曹強(qiáng)2016-03-013.7分發(fā)及訂閱接口更新任海洋2016-04-073.7.1推送接口更新任海洋2016-05-113.7.2電子面單新增

2、通知快遞員上門字段，推送接口新增貨款狀態(tài)推送詹益?zhèn)?016-07-014.0全新4.0接口，新增單號(hào)識(shí)別接口、智選物流接口、更新物流軌跡接口（訂閱查詢）詹益?zhèn)?016-9-264.0.1推送接口新增DataSign字段、訂閱2.0新增倉(cāng)庫(kù)標(biāo)識(shí)ID、智選物流接口新增字段胡蕾蕾2016-11-034.1新增在途監(jiān)控（增值服務(wù)）曹強(qiáng)2016-12-134.1.1電子面單新增第三方訂單號(hào)ThrOrderCode胡蕾蕾2017-1-104.2新增隱私快遞胡蕾蕾2017-2-164.2.1新增代收貨款業(yè)務(wù)胡蕾蕾2017-4-134.31、即時(shí)查詢接口中軌跡狀態(tài)新增0-無(wú)軌跡 2、普通回調(diào)接口中刪除201狀

3、態(tài)3、修改智選物流接口文檔4、電子面單接口添加特殊字符提示陳愛2017-4-254.41、 新增申請(qǐng)電子面單客戶號(hào)接口2、 新增電子面單余額查詢接口3、 新增電子面單單號(hào)回收接口4、 新增申請(qǐng)客戶號(hào)信息推送接口陳愛2017-6-224.5新增短信接口李旭安2017-7-144.6電子面單接口新增支持郵政快遞包裹吳明名詞定義必須要求說(shuō)明R必填（Required）。O可選（Optional）C報(bào)文中該參數(shù)在一定條件下可選（Conditional）1前言72概述82.1用戶使用流程圖82.2接口規(guī)范及說(shuō)明92.2.1報(bào)文及報(bào)文編碼92.2.2接入步驟102.2.3接口數(shù)據(jù)包結(jié)構(gòu)112.2.4JSON

4、 范例112.2.5流程示意圖122.2.6網(wǎng)關(guān)地址122.3簽名說(shuō)明122.3.1關(guān)于簽名122.3.2(C#)DataSign簽名加密代碼133下單153.1預(yù)約取件接口153.1.1功能說(shuō)明153.1.2接口規(guī)則153.1.3系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)153.1.4返回結(jié)果參數(shù)183.1.5Json請(qǐng)求示例183.1.6Json請(qǐng)求返回示例193.2電子面單203.2.1功能說(shuō)明203.2.2接口規(guī)則203.2.3系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)203.2.4返回結(jié)果參數(shù)243.3電子面單余量查詢接口253.3.1功能說(shuō)明253.3.2接口規(guī)則253.3.3系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)253.3.4返回結(jié)果

5、參數(shù)263.3.5JSON請(qǐng)求示例263.3.6JSON返回示例263.4電子面單單號(hào)取消273.4.1功能說(shuō)明273.4.2接口規(guī)則273.4.3系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)273.4.4返回結(jié)果參數(shù)283.4.5Json請(qǐng)求示例283.4.6Json請(qǐng)求返回示例283.5申請(qǐng)電子面單客戶號(hào)283.5.1功能說(shuō)明283.5.2接口規(guī)則293.5.3系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)293.5.4返回結(jié)果參數(shù)303.5.5Json請(qǐng)求示例303.5.6Json請(qǐng)求返回示例303.6申請(qǐng)客戶號(hào)信息推送313.6.1功能說(shuō)明313.6.2接口規(guī)則313.6.3系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)313.6.4返回結(jié)果參數(shù)313.

6、6.5Json請(qǐng)求示例323.6.6Json請(qǐng)求返回示例323.7增值服務(wù)列表323.8安全號(hào)碼接口333.8.1功能說(shuō)明333.8.2接口規(guī)則333.8.3系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)333.8.4返回結(jié)果參數(shù)353.8.5JSON請(qǐng)求示例353.8.6JSON請(qǐng)求返回示例364軌跡查詢374.1物流軌跡（即時(shí)查詢）374.1.1功能說(shuō)明374.1.2接口規(guī)則374.1.3系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)374.1.4返回結(jié)果參數(shù)374.1.5JSON請(qǐng)求示例384.1.6JSON返回示例384.2物流軌跡（訂閱查詢）404.2.1功能說(shuō)明404.2.2接口規(guī)則404.2.3系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)404.2

7、.4返回結(jié)果參數(shù)434.2.5JSON請(qǐng)求示例434.2.6JSON返回示例445異步推送（回調(diào)）接口455.1功能說(shuō)明455.2接口規(guī)則455.3系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)455.3.1訂閱查詢結(jié)果（RequestType：101）465.3.2訂閱查詢（增值版）結(jié)果（RequestType：102）475.3.3貨款狀態(tài)（RequestType：107）485.4返回結(jié)果參數(shù)495.5JSON請(qǐng)求示例495.6JSON返回示例536智能服務(wù)536.1智選物流536.1.1.功能說(shuō)明536.1.2.接口規(guī)則536.1.3.應(yīng)用級(jí)輸入?yún)?shù)546.1.4.返回結(jié)果參數(shù)566.1.5.JSON請(qǐng)求示例

8、576.1.6.JSON返回示例596.2運(yùn)費(fèi)模板導(dǎo)入接口616.2.1.功能說(shuō)明616.2.2.接口規(guī)則616.2.3.系統(tǒng)級(jí)輸入?yún)?shù)616.2.4.應(yīng)用級(jí)輸入?yún)?shù)626.2.5.返回結(jié)果參數(shù)636.2.6.JSON請(qǐng)求示例636.2.7.JSON返回示例646.3單號(hào)識(shí)別656.3.1.功能說(shuō)明656.3.2.接口規(guī)則656.3.3.系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)656.3.4.返回結(jié)果參數(shù)667在途監(jiān)控（增值版）667.1物流軌跡（即時(shí)查詢?cè)鲋蛋妫?67.1.1功能說(shuō)明667.1.2接口規(guī)則667.1.3系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)677.1.4返回結(jié)果參數(shù)677.1.5JSON請(qǐng)求示例687.1.6

9、JSON返回示例687.2物流軌跡（訂閱查詢?cè)鲋蛋妫?07.2.1功能說(shuō)明707.2.2接口規(guī)則717.2.3系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)717.2.4返回結(jié)果參數(shù)747.2.5JSON請(qǐng)求示例747.2.6JSON返回示例758短信758.1短信發(fā)送758.1.1功能說(shuō)明758.1.2接口規(guī)則758.1.3返回結(jié)果參數(shù)768.1.4JSON請(qǐng)求示例768.1.5JSON返回示例778.2短信模板778.2.1功能說(shuō)明778.2.2接口規(guī)則778.2.3系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)778.2.4返回結(jié)果參數(shù)788.2.5JSON請(qǐng)求示例788.2.6JSON返回示例798.3短信黑名單798.3.1功能說(shuō)

10、明798.3.2接口規(guī)則798.3.3系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)798.3.4返回結(jié)果參數(shù)808.3.5JSON請(qǐng)求示例808.3.6JSON返回示例819附錄819.1快遞公司編碼819.2常見問題解答Q&A819.3電子面單模板規(guī)格819.4返回編碼列表8310技術(shù)支持831 前言快遞鳥API旨在為電商、電商平臺(tái)、物流工具、倉(cāng)儲(chǔ)系統(tǒng)等等系統(tǒng)提供專業(yè)、穩(wěn)定、優(yōu)質(zhì)的物流服務(wù)，為不同的用戶量身定做了專業(yè)的API接口服務(wù)，供不同的用戶各取所需。本文檔就各個(gè)API接口進(jìn)行詳細(xì)的說(shuō)明，方便快遞鳥的用戶快速對(duì)接，方便快捷使用快遞鳥服務(wù)。2 概述2.1 用戶使用流程圖快遞鳥API全流程服務(wù)（電商）流程

11、圖基于電商現(xiàn)有的服務(wù)流程，快遞鳥為電商、電商平臺(tái)、ERP系統(tǒng)、倉(cāng)儲(chǔ)系統(tǒng)等系統(tǒng)在用戶下單、選擇物流、下單、打單、軌跡跟蹤等關(guān)鍵節(jié)點(diǎn)，均提供了專業(yè)、高效的API接口，方便各個(gè)平臺(tái)實(shí)現(xiàn)一次接入，便可使用國(guó)內(nèi)外主流物理公司的服務(wù)?？爝f鳥API全流程服務(wù)（工具）流程圖對(duì)于物流工具，基于用戶的操作習(xí)慣，只需要輸入單號(hào)，快遞鳥即可完成后續(xù)的物流公司識(shí)別、查詢軌跡等工作，為工具類用戶提供一站式的服務(wù)。2.2 接口規(guī)范及說(shuō)明2.2.1 報(bào)文及報(bào)文編碼 Json格式。 編碼格式：UTF-8 交互協(xié)議上統(tǒng)一用UTF-8，避免傳遞中文數(shù)據(jù)出現(xiàn)亂碼。2.2.2 接入步驟 注冊(cè)成為快遞鳥用戶(注：注冊(cè)成功后進(jìn)行實(shí)名認(rèn)證，

12、申請(qǐng)開通接口，后續(xù)會(huì)再對(duì)用戶的注冊(cè)信息進(jìn)行審批)。注冊(cè)成功后，登錄用戶管理后臺(tái)就可以查看到用戶所屬唯一的商戶ID和API key。 官網(wǎng)登陸網(wǎng)址：官網(wǎng)注冊(cè)網(wǎng)址：官網(wǎng)接口介紹網(wǎng)址：按照快遞鳥官網(wǎng)提示進(jìn)行注冊(cè)申請(qǐng)，注冊(cè)成功后登錄用戶管理后臺(tái)，您將得到由快遞鳥提供的一組商戶ID和API Key。商戶ID是調(diào)用接口服務(wù)的身份證明，不可更改、不可轉(zhuǎn)用，API Key是應(yīng)用訪問API的簽名附加密鑰，必須妥善保存。兩者關(guān)系類似于登錄帳號(hào)和密碼，兩者都會(huì)在簽名和業(yè)務(wù)參數(shù)中使用。注冊(cè)成功登錄用戶管理后臺(tái)可以查看商戶ID和API Key，需實(shí)名認(rèn)證后才能申請(qǐng)開通接口。(1) 開發(fā)服務(wù)開發(fā)自身業(yè)務(wù)的服務(wù)，服務(wù)需遵循

13、接口的定義規(guī)則。(2) 查看接口調(diào)用的DEMO快遞鳥物流技術(shù)接口提供調(diào)用快遞鳥物流接口的DEMO(.Net版本，Java版本，PHP版本)，包括網(wǎng)上在線訂單下單、物流軌跡查詢等物流行業(yè)標(biāo)準(zhǔn)化的下單操作流程與數(shù)據(jù)查詢格式。提交接入處理的相關(guān)代碼如有不明白的地方可與快遞鳥物流技術(shù)接口人協(xié)作開發(fā)。DEMO下載地址： (如鏈接無(wú)法打開，請(qǐng)打開瀏覽器，在瀏覽器中輸入)2.2.3 接口數(shù)據(jù)包結(jié)構(gòu)圖例 - 數(shù)據(jù)包結(jié)構(gòu) (系統(tǒng)級(jí)數(shù)據(jù))2.2.4 JSON 范例 string userID = "1109259" string keyValue = "56da2cf8-c8a2-4

14、4b2-b6fa-476cd7d1ba17"/加密私鑰，由發(fā)貨通提供 string url = "" /請(qǐng)求地址 string DataType = "2" 2-json string charset="UTF-8"/字符編碼采用UTF-8string jsonStr= ""OrderCode":"","ShipperCode":"SF","LogisticCode":"118461988807"

15、" / JSON字符串string datasign = HttpUtility.UrlEncode(base64( MD5(jsonStr+keyValue, "UTF-8"),"UTF-8"),Encoding.UTF8);/把(jsonStr+AppKey)進(jìn)行MD5加密，然后Base64編碼，最后 進(jìn)行URL(utf-8)編碼string PostStr = "RequestType=1002&EBusinessID= userID &RequestData=jsonStr &DataSign= dat

16、asign&DataType=DataType" /請(qǐng)求報(bào)文參數(shù)string post = this.DoPost(url, PostStr);/ 通訊協(xié)議使用Http協(xié)議Post請(qǐng)求方式2.2.5 流程示意圖2.2.6 網(wǎng)關(guān)地址測(cè)試接口：測(cè)試電商ID=1237100，AppKey=518a73d8-1f7f-441a-b644-33e77b49d846正式接口：nessOrderHandle.aspx2.3 簽名說(shuō)明2.3.1 關(guān)于簽名快遞鳥和第三方電子商務(wù)公司系統(tǒng)進(jìn)行對(duì)接，有一定的安全機(jī)制。采用IP認(rèn)證加簽名的方式對(duì)接，具體方案如下：(1) 防止數(shù)據(jù)被篡改在POST請(qǐng)求中

17、會(huì)傳遞5個(gè)必須（R）參數(shù)RequestData=數(shù)據(jù)內(nèi)容(URL編碼:UTF-8)EBusinessID=電商IDRequestType=請(qǐng)求指令類型DataSign= 數(shù)據(jù)內(nèi)容簽名：把（請(qǐng)求內(nèi)容（未編碼）+ApiKey）進(jìn)行MD5加密，然后Base64編碼，最后進(jìn)行URL（utf-8）編碼DataType=返回?cái)?shù)據(jù)類型(2-json)注：DataSign生成后，對(duì)方接收到數(shù)據(jù)后，以同樣的算法進(jìn)行簽名，生成摘要，對(duì)比兩者的摘要是否相同，如果不同，說(shuō)明傳遞過(guò)程中發(fā)生數(shù)據(jù)篡改，對(duì)接過(guò)程中如有不明白之處可雙方技術(shù)協(xié)作進(jìn)行(2) 調(diào)用接口的身份認(rèn)證注冊(cè)成為快遞鳥用戶后，會(huì)生成對(duì)應(yīng)的電商ID和AppKe

18、y，電商ID相當(dāng)于用戶名，AppKey相當(dāng)于密碼。注：請(qǐng)勿遺漏或傳遞可能遞增大快遞鳥接口調(diào)用維護(hù)舉例說(shuō)明：(a) 假設(shè)RequestData (JSON)內(nèi)容為： “OrderCode”:”,“ShipperCode”:”SF”,”LogisticCode”:" 1"經(jīng)過(guò)URL(UTF-8)編碼的內(nèi)容為%7b%27OrderCode%27%3a%27%27%2c%27ShipperCode%27%3a%27SF%27%2c%27LogisticCode%27%3a%271%27%7d， EBusinessID為，AppKey為56da2cf8-c8a2-44b2-b6fa-

19、476cd7d1ba17(b) 那么DataSign簽名的內(nèi)容為'OrderCode':'','ShipperCode':'SF','LogisticCode':'1'56da2cf8-c8a2-44b2-b6fa-476cd7d1ba17，經(jīng)過(guò)md5和base64后的內(nèi)容就為OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE=，在經(jīng)過(guò)URL(UTF-8)編碼的內(nèi)容為OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE%3d最終要

20、發(fā)送的數(shù)據(jù)為RequestType=1002&EBusinessID=&RequestData =%7b%27OrderCode%27%3a%27%27%2c%27ShipperCode%27%3a%27SF%27%2c%27LogisticCode%27%3a%271%27%7d &DataSign =OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE%3d& DataType=2(c) 接收方收到數(shù)據(jù)后，獲得EBusinessID 和RequestData和DataSign等這幾個(gè)數(shù)據(jù)。(d) 接收方對(duì)EBusinessI

21、D 得到AppKey，RequestData+AppKey的數(shù)據(jù)進(jìn)行md5和base64后的內(nèi)容就為OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE=(e) 接收方判斷簽名后的數(shù)據(jù)跟傳遞過(guò)來(lái)的DataSign是否一致，如果一致進(jìn)行業(yè)務(wù)操作，如果不一致返回錯(cuò)誤。2.3.2 (C#)DataSign簽名加密代碼/<summary>/電商Sign簽名/</summary>/<param name="content">內(nèi)容</param>/<param name="keyValue

22、">Appkey</param>/<param name="charset">URL編碼 </param>/<returns>DataSign簽名</returns>Public String Encrypt (String content, String keyValue, String charset)if (keyValue != null)return base64(MD5(content + keyValue, charset), charset);return base64(MD5(co

23、ntent, charset), charset);/<summary>/ 字符串MD5加密/</summary>/<param name="Text">要加密的字符串</param>/<returns>密文</returns>Private string MD5(string Text, string charset)byte buffer = System.Text.Encoding.GetEncoding(charset).GetBytes(Text);try System.Security.Cr

24、yptography.MD5CryptoServiceProvider check; check = new System.Security.Cryptography.MD5CryptoServiceProvider();byte somme = check.ComputeHash(buffer);string ret = ""foreach (byte a in somme) if (a < 16) ret += "0" + a.ToString("X");else ret += a.ToString("X"

25、;); return ret.ToLower();catch throw; Private static string base64(String str, String charset)returnConvert.ToBase64String(System.Text.Encoding.GetEncoding(charset).GetBytes(str);3 下單3.1 預(yù)約取件接口3.1.1 功能說(shuō)明 預(yù)約取件接口是快遞鳥提供給獨(dú)立電商、倉(cāng)儲(chǔ)管理系統(tǒng)、物流供應(yīng)鏈等物流系統(tǒng)平臺(tái)使用的下單接口，為客戶解決在線發(fā)貨需求，客戶通過(guò)網(wǎng)絡(luò)選擇快遞公司發(fā)送請(qǐng)求通知貴公司有快遞要發(fā)貨，貴公司把數(shù)據(jù)通過(guò)此接口

26、轉(zhuǎn)發(fā)到快遞鳥，由快遞鳥為您提供通知快遞員上門取件的服務(wù)。3.1.2 接口規(guī)則 (1)、訂單編號(hào)(OrderCode)不可重復(fù)提交，重復(fù)提交系統(tǒng)會(huì)返回具體錯(cuò)誤代碼。 (2)、目前預(yù)約取件接口支持了：德邦、EMS、天地華宇、百世快遞、京東、龍邦快遞、順豐快遞、中通速遞、韻達(dá)快遞、圓通速遞、宅急送，后續(xù)更多的快遞公司正在對(duì)接中。 (3)、接口只支持Json格式參數(shù)，接口指令1001。只支持POST請(qǐng)求方式，utf-8編碼。 (4)、支持增值服務(wù)，保價(jià)、代收貨款、貨款直退、貨款墊付等。(5)、測(cè)試地址： 正式地址：3.1.3 系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)系統(tǒng)級(jí)輸入?yún)?shù)應(yīng)用級(jí)輸入?yún)?shù)類型是否必須描述Reque

27、stData（必填參數(shù)，請(qǐng)求內(nèi)容，JSON格式,須和DataType一致）WarehouseIDStringO倉(cāng)庫(kù)標(biāo)識(shí)(備用字段)WarehouseAddressStringO倉(cāng)庫(kù)地址(備用字段)CallBackStringO商戶標(biāo)識(shí)(備用字段)MemberIDStringO會(huì)員標(biāo)識(shí)(備用字段)ShipperCodeStringR快遞公司編碼LogisticCodeStringO快遞單號(hào)OrderCodeStringR訂單編號(hào)MonthCodeStringC月結(jié)編碼PayTypeIntR郵費(fèi)支付方式:1-現(xiàn)付，2-到付，3-月結(jié)，4-第三方支付ExpTypeIntR快遞類型：1-標(biāo)準(zhǔn)快件Cos

28、tDoubleO寄件費(fèi)（運(yùn)費(fèi)）OtherCostDoubleO其他費(fèi)用ReceiverCompanyStringO收件人公司NameStringR收件人TelStringR電話與手機(jī)，必填一個(gè)MobileStringPostCodeStringO收件人郵編ProvinceNameStringR收件?。ㄈ鐝V東省，不要缺少“省”）CityNameStringR收件市（如深圳市，不要缺少“市”）ExpAreaNameStringO收件區(qū)（如福田區(qū)，不要缺少“區(qū)”或“縣”）AddressStringR收件人詳細(xì)地址SenderCompanyStringO發(fā)件人公司NameStringR發(fā)件人TelSt

29、ringR電話與手機(jī)，必填一個(gè)MobileStringPostCodeStringO發(fā)件人郵編ProvinceNameStringO發(fā)件?。ㄈ鐝V東省，不要缺少“省”）CityNameStringR發(fā)件市（如深圳市，不要缺少“市”）ExpAreaNameStringO發(fā)件區(qū)（如福田區(qū)，不要缺少“區(qū)”或“縣”）AddressStringR發(fā)件詳細(xì)地址StartDateStringO上門取貨時(shí)間段:"yyyy-MM-dd HH:mm:ss"格式化，本文中所有時(shí)間格式相同EndDateStringOWeightDoubleO物品總重量kgQuantityIntO件數(shù)/包裹數(shù)Volu

30、meDoubleO物品總體積m3RemarkStringO備注AddServiceNameString0增值服務(wù)名稱ValueString0增值服務(wù)值CustomerIDString0客戶標(biāo)識(shí)(選填)CommodityGoodsNameStringR商品名稱GoodsCodeStringO商品編碼GoodsquantityIntO件數(shù)GoodsPriceDoubleO商品價(jià)格GoodsWeightDoubleO商品重量kgGoodsDescStringO商品描述GoodsVolDoubleO商品體積m3EBusinessIDStringR電商IDRequestTypeStringR請(qǐng)求指令類型

31、：1001DataSignStringR數(shù)據(jù)內(nèi)容簽名DataTypeStringR請(qǐng)求、返回?cái)?shù)據(jù)類型：2-json；3.1.4 返回結(jié)果參數(shù)參數(shù)名稱類型必須要求說(shuō)明EBusinessIDStringR電商用戶IDOrderOrderCodeStringR訂單編號(hào)ShipperCodeStringR快遞公司編碼LogisticCodeStringO快遞單號(hào)SuccessBoolR成功與否ResultCodeStringR結(jié)果編號(hào)ReasonStringO失敗原因UniquerRequestNumberStringR唯一標(biāo)識(shí)3.1.5 Json請(qǐng)求示例 "OrderCode":

32、 "9", "ShipperCode": "SF", "PayType": 1, "MonthCode": "7553045845", "ExpType": 1, "Cost": 1.0, "OtherCost": 1.0, "Sender": "Company": "LV", "Name": "Taylor", &q

33、uot;Mobile": "", "ProvinceName": "上海", "CityName": "上海", "ExpAreaName": "青浦區(qū)", "Address": "明珠路" , "Receiver": "Company": "GCCUI", "Name": "Yann", "Mob

34、ile": "", "ProvinceName": "北京", "CityName": "北京", "ExpAreaName": "朝陽(yáng)區(qū)", "Address": "三里屯街道" , "Commodity": "GoodsName": "鞋子", "Goodsquantity": 1, "GoodsWeight&qu

35、ot;: 1.0 , "AddService": "Name": "COD", "Value": "1020" , "Weight": 1.0, "Quantity": 1, "Volume": 0.0, "Remark": "小心輕放"3.1.6 Json請(qǐng)求返回示例 "EBusinessID": "1237100", "Success"

36、;: true, "Order": "OrderCode": "9", " ShipperCode ": " SF ", " LogisticCode ": "" , "ResultCode": "100", "Reason": ""3.2 電子面單3.2.1 功能說(shuō)明電子面單接口是快遞鳥提供給獨(dú)立電商、倉(cāng)儲(chǔ)管理系統(tǒng)、物流供應(yīng)鏈等物流系統(tǒng)平臺(tái)使用的下單接口，滿足客戶在線發(fā)貨需求

37、并提供打印面單的服務(wù)，客戶通過(guò)網(wǎng)絡(luò)選擇物流公司發(fā)送請(qǐng)求通知貴公司有快遞要發(fā)貨，貴公司把數(shù)據(jù)通過(guò)此接口轉(zhuǎn)發(fā)到快遞鳥，由快遞鳥為您通知對(duì)應(yīng)的快遞公司快遞員上門取件。電子面單成功下單后，快遞鳥系統(tǒng)內(nèi)將自動(dòng)訂閱，一旦軌跡發(fā)生變化時(shí)，快遞鳥將調(diào)用客戶方推送接收接口。同時(shí)若客戶使用代收貨款服務(wù)，快遞鳥會(huì)將代收貨款的貨款狀態(tài)獨(dú)立推送給用戶。3.2.2 接口規(guī)則(1)、只支持Json格式。接口指令1007。(2)、訂單編號(hào)(OrderCode)不可重復(fù)提交，重復(fù)提交系統(tǒng)會(huì)返回具體錯(cuò)誤代碼。(3)、目前接口支持了：順豐（SF）、EMS（EMS）、宅急送（ZJS）、圓通（YTO）、百世快遞（HTKY）、中通（ZT

38、O）、韻達(dá)（YD）、申通（STO）、德邦（DBL）、優(yōu)速（UC）、京東（JD）、信豐（XFEX）、全峰（QFKD）、跨越速運(yùn)（KYSY）、安能小包（ANE）、快捷快遞（FAST）、國(guó)通（GTO）、天天快遞（HHTT）、郵政快遞包裹（YZPY），后續(xù)更多的快遞公司正在對(duì)接中。散戶模式（無(wú)需電子面單客戶號(hào)）支持快遞公司：順豐（SF）、EMS（EMS）（僅支持廣東省內(nèi)發(fā)貨）、快捷快遞（FAST）、宅急送（ZJS）、郵政快遞包裹（YZPY），后續(xù)更多的快遞公司正在對(duì)接中。(4)、測(cè)試地址：(5)、正式地址： (6)、請(qǐng)求報(bào)文中不允許出現(xiàn)以下特殊字符： ' " # & + &l

39、t; >3.2.3 系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)系統(tǒng)級(jí)輸入?yún)?shù)應(yīng)用級(jí)輸入?yún)?shù)類型是否必須描述RequestData（必填參數(shù)，請(qǐng)求內(nèi)容，JSON格式,須和DataType一致）CallBackStringO用戶自定義回調(diào)信息MemberIDStringO會(huì)員標(biāo)識(shí)平臺(tái)方與快遞鳥統(tǒng)一用戶標(biāo)識(shí)的商家IDCustomerNameStringO電子面單客戶賬號(hào)（與快遞網(wǎng)點(diǎn)申請(qǐng)或通過(guò)快遞鳥官網(wǎng)申請(qǐng)或通過(guò)申請(qǐng)電子面單客戶號(hào)申請(qǐng)）CustomerPwdStringO電子面單密碼SendSiteStringO收件網(wǎng)點(diǎn)標(biāo)識(shí)ShipperCodeStringR快遞公司編碼LogisticCodeStringO快遞單

40、號(hào)ThrOrderCodeStringO第三方訂單號(hào)OrderCodeStringR訂單編號(hào)MonthCodeStringC月結(jié)編碼PayTypeIntR郵費(fèi)支付方式:1-現(xiàn)付，2-到付，3-月結(jié)，4-第三方支付ExpTypeStringR快遞類型：1-標(biāo)準(zhǔn)快件IsNoticeIntO是否通知快遞員上門攬件：0-通知；1-不通知；不填則默認(rèn)為1CostDoubleO寄件費(fèi)（運(yùn)費(fèi)）OtherCostDoubleO其他費(fèi)用ReceiverCompanyStringO收件人公司NameStringR收件人TelStringR電話與手機(jī)，必填一個(gè)MobileStringPostCodeStringO收

41、件人郵編ProvinceNameStringR收件?。ㄈ鐝V東省，不要缺少“省”）CityNameStringR收件市（如深圳市，不要缺少“市”）ExpAreaNameStringO收件區(qū)（如福田區(qū)，不要缺少“區(qū)”或“縣”）AddressStringR收件人詳細(xì)地址SenderCompanyStringO發(fā)件人公司NameStringR發(fā)件人TelStringR電話與手機(jī)，必填一個(gè)MobileStringPostCodeStringO發(fā)件人郵編ProvinceNameStringR發(fā)件?。ㄈ鐝V東省，不要缺少“省”）CityNameStringR發(fā)件市（如深圳市，不要缺少“市”）ExpAreaNa

42、meStringO發(fā)件區(qū)（如福田區(qū)，不要缺少“區(qū)”或“縣”）AddressStringR發(fā)件詳細(xì)地址StartDateStringO上門取貨時(shí)間段:"yyyy-MM-dd HH:mm:ss"格式化，本文中所有時(shí)間格式相同EndDateStringOWeightDoubleO物品總重量kgQuantityIntO件數(shù)/包裹數(shù)VolumeDoubleO物品總體積m3RemarkStringO備注AddServiceNameString0增值服務(wù)名稱ValueString0增值服務(wù)值CustomerIDString0客戶標(biāo)識(shí)(選填)CommodityGoodsNameString

43、R商品名稱GoodsCodeStringO商品編碼GoodsquantityIntO件數(shù)GoodsPriceDoubleO商品價(jià)格GoodsWeightDoubleO商品重量kgGoodsDescStringO商品描述GoodsVolDoubleO商品體積m3IsReturnPrintTemplateStringO返回電子面單模板：0-不需要；1-需要IsSendMessageIntO是否訂閱短信0-不需要；1-需要TemplateSizeStringO模板尺寸EBusinessIDStringR商戶IDRequestTypeStringR請(qǐng)求指令類型：1007DataSignStringR數(shù)

44、據(jù)內(nèi)容簽名DataTypeStringR請(qǐng)求、返回?cái)?shù)據(jù)類型： 2-json3.2.4 返回結(jié)果參數(shù)l 同步返回參數(shù)名稱類型必須要求說(shuō)明EBusinessIDStringR電商用戶IDOrderOrderCodeStringR訂單編號(hào)ShipperCodeStringR快遞公司編碼LogisticCodeStringR快遞單號(hào)MarkDestinationStringO大頭筆OriginCodeStringO始發(fā)地區(qū)域編碼OriginNameStringO始發(fā)地/始發(fā)網(wǎng)點(diǎn)DestinatioCodeStringO目的地區(qū)域編碼DestinatioNameStringO目的地/到達(dá)網(wǎng)點(diǎn)Sortin

45、gCodeStringO分揀編碼PackageCodeStringO集包編碼SuccessBoolR成功與否ResultCodeStringR錯(cuò)誤編碼ReasonStringO失敗原因UniquerRequestNumberStringR唯一標(biāo)識(shí)PrintTemplateStringO面單打印模板EstimatedDeliveryTimeStringO訂單預(yù)計(jì)到貨時(shí)間yyyy-mm-ddCallbackStringO用戶自定義回調(diào)信息SubCountIntO子單數(shù)量SubOrdersStringO子單號(hào)SubPrintTemplatesStringO子單模板ReceiverSafePhoneS

46、tringO收件人安全電話SenderSafePhoneString0寄件人安全電話DialPageStringR撥號(hào)頁(yè)面網(wǎng)址（轉(zhuǎn)換成二維碼可掃描撥號(hào)）3.3 電子面單余量查詢接口3.3.1 功能說(shuō)明用戶查詢客戶號(hào)在快遞公司的單號(hào)剩余量。3.3.2 接口規(guī)則(1) 、接口只支持Json格式參數(shù)，接口指令1127。只支持POST請(qǐng)求方式，utf-8編碼。(2) 、目前支持快遞公司：優(yōu)速，中通，韻達(dá)，后續(xù)更多的快遞公司正在對(duì)接中。 3.3.3 系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)系統(tǒng)級(jí)輸入?yún)?shù)類型應(yīng)用級(jí)輸入?yún)?shù)必須要求描述RequestData（必填參數(shù)，請(qǐng)求內(nèi)容，JSON格式,須和DataType一致）Str

47、ingShipperCodeR快遞公司編碼StringCustomerNameR電子面單賬號(hào)StringCustomerPwdO電子面單密碼StringStationCodeO網(wǎng)點(diǎn)編碼StringStationNameO網(wǎng)點(diǎn)EBusinessIDStringR電商IDRequestTypeStringR請(qǐng)求指令類型：1127DataSignStringR數(shù)據(jù)內(nèi)容簽名DataTypeStringR請(qǐng)求、返回?cái)?shù)據(jù)類型： 2-json；3.3.4 返回結(jié)果參數(shù)參數(shù)名稱類型必須要求說(shuō)明EbusinessIDStringR用戶IDSuccessBoolR成功與否：true,falseReasonStri

48、ngO原因ResultCodeStringR返回結(jié)果編號(hào)EorderBalanceTotalNumIntO累計(jì)充值數(shù)量，電子面單總量(包含已使用/未使用)AvailableNumIntO可用量(剩余量) "ShipperCode": "UC", "CustomerName": "80238728", "CustomerPwd": "c0bfe0ba86b66bae5426303c53db0a81", "StationCode": "3001&qu

49、ot;, "StationName": "福田網(wǎng)點(diǎn)"3.3.5 JSON請(qǐng)求示例3.3.6 JSON返回示例 "EBusinessID": "1261602", "Success": true, "Reason": "", "ResultCode": "100", "EorderBalance": "AvailableNum": 0, "TotalNum":

50、 0 3.4 電子面單單號(hào)取消3.4.1 功能說(shuō)明快遞鳥通用接口提交快遞公司編碼、快遞單號(hào)，則可以取消提交單號(hào)。僅支持未攬件狀態(tài)快遞單進(jìn)行取消，取消后的回收規(guī)則以快遞公司為準(zhǔn)。3.4.2 接口規(guī)則(1) 、接口指令1147。(2) 、目前支持快遞公司：優(yōu)速，后續(xù)更多的快遞公司正在對(duì)接中。3.4.3 系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)系統(tǒng)級(jí)輸入?yún)?shù)類型應(yīng)用級(jí)輸入?yún)?shù)必須要求描述RequestData（必填參數(shù)，請(qǐng)求內(nèi)容，JSON格式,須和DataType一致）StringShipperCodeR快遞公司編碼StringExpNoR運(yùn)單號(hào)StringCustomerNameR客戶號(hào)StringCustomer

51、PwdO客戶號(hào)密碼EBusinessIDStringR電商IDRequestTypeStringR請(qǐng)求指令類型：1147DataSignStringR數(shù)據(jù)內(nèi)容簽名DataTypeStringR請(qǐng)求、返回?cái)?shù)據(jù)類型： 2-json；3.4.4 返回結(jié)果參數(shù)參數(shù)名稱類型必須要求說(shuō)明EbusinessIDStringR用戶IDSuccessBoolR成功與否：true,falseResultCodeStringO結(jié)果編碼ReasonStringO原因3.4.5 Json請(qǐng)求示例 "ShipperCode": "UC", "ExpNo": &q

52、uot;9", "CustomerName": "80238728", "CustomerPwd": "c0bfe0ba86b66bae5426303c53db0a8b"3.4.6 Json請(qǐng)求返回示例 "EBusinessID": "1261602", "Success": true, "ResultCode": "100"3.5 申請(qǐng)電子面單客戶號(hào)3.5.1 功能說(shuō)明客戶通過(guò)快遞鳥平臺(tái)向快遞公司申請(qǐng)客戶

53、號(hào)3.5.2 接口規(guī)則(1)、接口只支持Json格式參數(shù)，接口指令1107。只支持POST請(qǐng)求方式，utf-8編碼。 (2)、測(cè)試地址： /api/apiservice(3) 、正式地址： /api/apiservice(4) 、目前支持快遞公司：優(yōu)速，后續(xù)更多的快遞公司正在對(duì)接中。3.5.3 系統(tǒng)級(jí)和應(yīng)用級(jí)輸入?yún)?shù)系統(tǒng)級(jí)輸入?yún)?shù)類型應(yīng)用級(jí)輸入?yún)?shù)必須要求描述RequestData（必填參數(shù)，請(qǐng)求內(nèi)容，JSON格式,須和DataType一致）stringShipperCodeR快遞公司編碼StationCodeR網(wǎng)點(diǎn)編碼StationNameR網(wǎng)點(diǎn)ApplyIDO申請(qǐng)ID（用戶記錄在快遞公司的

54、標(biāo)識(shí)）CompanyO公司NameR聯(lián)系人TelC電話MobileC手機(jī)ProvinceNameR省份ProivnceCodeO省編碼CityNameR城市CityCodeO城市編碼ExpAreaNameR區(qū)縣ExpAreaCodeO區(qū)縣編碼AddressR詳細(xì)地址EBusinessIDStringR電商IDRequestTypeStringR請(qǐng)求指令類型：1107DataSignStringR數(shù)據(jù)內(nèi)容簽名DataTypeStringR請(qǐng)求、返回?cái)?shù)據(jù)類型： 2-json；3.5.4 返回結(jié)果參數(shù)參數(shù)名稱類型是否必須描述EbusinessIDStringR用戶IDSuccessBoolR成功與否：true,falseResultCodeStringO結(jié)果編碼ReasonStringO原因3.5.5 Json請(qǐng)求示例 "ShipperCode": "UC", "Company": "XXX", "ApplyID": "", "Name&qu