首頁 > API文檔 > 電子面單API
電子面單API為用户提供電子面單下單服務，快遞鳥連接多家物流公司，一次接入即可對接多家物流公司電子面單下單通道，為訂單信息化、標準化提供保障服務。用户接通快遞鳥電子面單API，即可直接下單順豐、EMS、宅急送、郵政快遞包裹等七家公司面單，無需申請開通其他服務。
快遞公司支持情況
順豐速運、EMS、宅急送、圓通速遞、百世快遞、中通快遞、韻達速遞、申通快遞、德邦快遞、優速快遞、京東快遞、信豐物流、安能快遞、國通快遞、天天快遞、跨越速運、郵政快遞包裹、中鐵快運、郵政國內標快、遠成快運、全一快遞、速爾快遞、品駿快遞。快運公司支持情況
德邦快運、安能快運、京東快運、龍邦快運。| 賬號類型 | 支持快遞公司 |
|---|
| 無需申請直接打單 | 順豐（SF）、EMS（EMS）（僅支持廣東省內發貨）、宅急送（ZJS）、郵政快遞包裹（YZPY）、中鐵快運（ZTKY）、郵政國內標快（YZBK），全一快遞（UAPEX） |
| 月結賬號直接打單 | 德邦（DBL）、EMS（EMS） |
| 快遞鳥後台申請賬號 | 優速（UC）、韻達（YD）、圓通（YTO）、遠成（YCWL）、安能（ANE）、百世快遞（HTKY） |
| 線下（網點）申請賬號 | EMS（EMS）、中通（ZTO）、申通（STO）、德邦（DBL）、京東（JD）、信豐（XFEX）、國通（GTO）、天天快遞（HHTT）、速爾快遞（SURE）、品駿快遞（PJ） |
| 快運電子面單 | 京東快運（JDKY）,安能快運（ANEKY）,德邦快運（DBLKY），龍邦快運（LB）。 |
更多快遞公司，陸續接入中。
下單+打印
a)商家操作發貨時同步訂單的發/收件人信息、貨物信息，通過接口直接發送到快遞公司獲取電子面單單號、大頭筆、電子面單打印模板等信息。通過瀏覽器或CS結構客户端打印工具進行打印電子面單。
商家使用流程
一、接口描述/説明
1.電子面單接口
（1）電子面單接口是快遞鳥提供給獨立電商、倉儲管理系統、物流供應鏈等物流系統平台使用的下單接口。
（2）為客户解決在線發貨需求，商户通過網絡選擇快遞公司發送請求通知快遞公司有快遞要發貨。
（3） 客户把數據通過此接口轉發到快遞鳥，由快遞鳥為您安排快遞員上門取件的服務。
（4）訂單編號（OrderCode）不可重複提交，重複提交系統會返回具體錯誤代碼。
（5）接口支持的消息接收方式為HTTP POST，請求方法的編碼格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8"。
（6）接口地址： API測試地址：//sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址：//api.kdniao.com/api/EOrderService
請求系統級參數説明：
| 參數名稱 | 類型 | 説明 | 必須要求 |
|---|
| RequestData | String | 請求內容需進行URL(utf-8)編碼。請求內容JSON格式，須和DataType一致。 | R |
| EBusinessID | String | 商户ID，請在我的服務頁面查看。 | R |
| RequestType | String | 請求指令類型：1007 | R |
| DataSign | String | 數據內容簽名：把(請求內容(未編碼)+AppKey)進行MD5加密，然後Base64編碼，最後 進行URL(utf-8)編碼。詳細過程請查看Demo。 | R |
| DataType | String | 請求、返回數據類型：只支持JSON格式 | O |
備註：R-必填（Required），O-可選（Optional），C-報文中該參數在一定條件下可選（Conditional）
2.訂單取消接口
（1）只支持有成功下單記錄的訂單進行取消。
（2）只支持對未攬件的訂單進行取消。
（3）訂單取消後，訂單號仍不可重複使用。
（4）訂單取消後快遞單號的回收規則以快遞公司為準。
（5）接口地址： API測試地址：//sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址：//api.kdniao.com/api/EOrderService
請求系統級參數説明：
| 參數名稱 | 類型 | 説明 | 必須要求 |
|---|
| RequestData | String | 請求內容需進行URL(utf-8)編碼。請求內容JSON格式，須和DataType一致。 | R |
| EBusinessID | String | 商户ID，請在我的服務頁面查看。 | R |
| RequestType | String | 請求指令類型：1147 | R |
| DataSign | String | 數據內容簽名：把(請求內容(未編碼)+AppKey)進行MD5加密，然後Base64編碼，最後 進行URL(utf-8)編碼。詳細過程請查看Demo。 | R |
| DataType | String | 請求、返回數據類型：只支持JSON格式 | O |
備註：R-必填（Required），O-可選（Optional），C-報文中該參數在一定條件下可選（Conditional）
3.單號餘量查詢接口
請求系統級參數説明：
| 參數名稱 | 類型 | 説明 | 必須要求 |
|---|
| RequestData | String | 請求內容需進行URL(utf-8)編碼。請求內容JSON格式，須和DataType一致。 | R |
| EBusinessID | String | 商户ID，請在我的服務頁面查看。 | R |
| RequestType | String | 請求指令類型：1127 | R |
| DataSign | String | 數據內容簽名：把(請求內容(未編碼)+AppKey)進行MD5加密，然後Base64編碼，最後 進行URL(utf-8)編碼。詳細過程請查看Demo。 | R |
| DataType | String | 請求、返回數據類型：只支持JSON格式 | O |
備註：R-必填（Required），O-可選（Optional），C-報文中該參數在一定條件下可選（Conditional）
4.客户號申請接口
請求系統級參數説明：
| 參數名稱 | 類型 | 説明 | 必須要求 |
|---|
| RequestData | String | 請求內容需進行URL(utf-8)編碼。請求內容JSON格式，須和DataType一致。 | R |
| EBusinessID | String | 商户ID，請在我的服務頁面查看。 | R |
| RequestType | String | 請求指令類型：1127 | R |
| DataSign | String | 數據內容簽名：把(請求內容(未編碼)+AppKey)進行MD5加密，然後Base64編碼，最後 進行URL(utf-8)編碼。詳細過程請查看Demo。 | R |
| DataType | String | 請求、返回數據類型：只支持JSON格式 | O |
備註：R-必填（Required），O-可選（Optional），C-報文中該參數在一定條件下可選（Conditional）
5.客户號推送接口
（1）推送時會推送RequestType、RequestData和DataSign三個參數 (格式：RequestData={數據}&EBusinessID=1237100 &PushTime=2017-04-18 23:34:29&RequestType=1117) 。
請求系統級參數説明：
| 參數名稱 | 類型 | 説明 | 必須要求 |
|---|
| RequestData | String | 請求內容需進行URL(utf-8)編碼。請求內容JSON格式，須和DataType一致。 | R |
| EBusinessID | String | 商户ID，請在我的服務頁面查看。 | R |
| RequestType | String | 請求指令類型：1117 | R |
| DataSign | String | 數據內容簽名：把(請求內容(未編碼)+AppKey)進行MD5加密，然後Base64編碼，最後 進行URL(utf-8)編碼。詳細過程請查看Demo。 | R |
| DataType | String | 請求、返回數據類型：只支持JSON格式 | O |
備註：R-必填（Required），O-可選（Optional），C-報文中該參數在一定條件下可選（Conditional）
二、接口參數
1.電子面單接口
請求內容字段定義：
| 參數名稱 | 類型 | 説明 | 是否必須 |
|---|
| MemberID | String（50） | ERP系統、電商平台等系統或平台類型用户的會員ID或店鋪賬號等唯一性標識，用於區分其用户 | O |
| CustomerName | String(50) | 電子面單客户號，需要下載《快遞鳥電子面單客户號參數對照表.xlsx》，參考對應字段傳值 | O |
| CustomerPwd | String(30) | O |
| SendSite | String(30) | O |
| SendStaff | String(30) | C |
| MonthCode | String | C |
| CustomArea | String(500) | 商家自定義區域 | C |
| WareHouseID | String(30) | 發貨倉編碼 | O |
| TransType | Int(1) | 運輸方式 1- 陸運 2- 空運 不填默認為1 | O |
| ShipperCode | String(10) | 快遞公司編碼 詳細編碼參考《快遞鳥接口支持快遞公司編碼.xlsx》 | R |
| LogisticCode | String(30) | 快遞單號(僅宅急送可用) | O |
| ThrOrderCode | String(50) | 第三方訂單號 (ShipperCode為JD且ExpType為1時必填) | C |
| OrderCode | String(30) | 訂單編號(自定義，不可重複) | R |
| PayType | Int(1) | 郵費支付方式:1-現付，2-到付，3-月結，4-第三方支付(僅SF支持) | R |
| ExpType | String(2) | 快遞類型：1-標準快件 ,詳細快遞類型參考《快遞公司快遞業務類型.xlsx》 | R |
| IsReturnSignBill | Int(1) | 是否要求籤回單 1- 要求 0-不要求 | O |
| OperateRequire | String(20) | 籤回單操作要求(如：簽名、蓋章、身份證複印件等) | O |
| Cost | Cost Double(5) | 快遞運費 | O |
| OtherCost | Double(5) | 其他費用 | O |
| Receiver | Company | String(30) | 收件人公司 | O |
| Name | String(30) | 收件人 | R |
| Tel | String(20) | 電話與手機，必填一個 | R |
| Mobile | String(20) |
| PostCode | String(10) | 收件人郵編 | c |
| ProvinceName | String(20) | 收件省 (如廣東省，不要缺少“省”；如是直轄市，請直接傳北京、上海等； 如是自治區，請直接傳廣西壯族自治區等) | R |
| CityName | String（20） | 收件市(如深圳市，不要缺少“市”； 如果是市轄區，請直接傳北京市、上海市等) | R |
| ExpAreaName | String（20） | 收件區/縣(如福田區，不要缺少“區”或“縣”) | R |
| Address | String(100) | 收件人詳細地址 | R |
| Sender | Company | String(30) | 發件人公司 | O |
| Name | String(30) | 發件人 | R |
| Tel | String(20) | 電話與手機，必填一個 | R |
| Mobile | String(20) |
| PostCode | String(10) | 發件地郵編(ShipperCode為EMS、YZPY、YZBK時必填) | C |
| ProvinceName | String(20) | 發件省 (如廣東省，不要缺少“省”； 如是直轄市，請直接傳北京、上海等； 如是自治區，請直接傳廣西壯族自治區等) | R |
| CityName | String(20) | 發件市(如深圳市，不要缺少“市； 如是市轄區，請直接傳北京市、上海市等”) | R |
| ExpAreaName | String(20) | 發件區/縣(如福田區，不要缺少“區”或“縣”) | R |
| Address | String(100) | 發件人詳細地址 | R |
| IsNotice | Int(1) | 是否通知快遞員上門攬件 0- 通知 1- 不通知 不填則默認為1 | O |
| StartDate | Date | 上門取貨時間段:"yyyy-MM-dd HH:mm:ss"格式化，本文中所有時間格式相同 | O |
| EndDate | Date | O |
| Weight | Double(10,3) | 包裹總重量kg 當為快運的訂單時必填，不填時快遞鳥將根據各個快運公司要求傳對應的默認值 | C |
| Quantity | Int(2) | 包裹數(最多支持30件) 一個包裹對應一個運單號，如果是大於1個包裹，返回則按照子母件的方式返回母運單號和子運單號 | R |
| Volume | Double(20,3) | 包裹總體積m3 當為快運的訂單時必填，不填時快遞鳥將根據各個快運公司要求傳對應的默認值 | C |
| Remark | String(60) | 備註 | O |
| AddServices |
| AddService | Name | String(20) | 增值服務名稱
(數組形式，可以有多個增值服務) | C |
| Value | String(30) | 增值服務值 | C |
| CustomerID | String(30) | 客户標識（選填） | O |
| Commoditys |
| Commodity | GoodsName | String(100) | 商品名稱 | R |
| GoodsCode | String(100) | 商品編碼 | O |
| Goodsquantity | Int(5) | 商品數量 | O |
| GoodsPrice | Double(10) | 商品價格 | O |
| GoodsWeight | Double(10,3) | 商品重量kg | O |
| GoodsDesc | String(50) | 商品描述 | O |
| GoodsVol | Double(15,3) | 商品體積m3 | O |
| IsReturnPrintTemplate | String(1) | 返回電子面單模板：0-不需要；1-需要 | O |
| IsSendMessage | Int(1) | 是否訂閲短信：0-不需要；1-需要 | O |
| TemplateSize | String(10) | 模板規格(默認的模板無需傳值，非默認模板傳對應模板尺寸) | O |
| PackingType | Int(2) | 包裝類型(快運字段)默認為0； 0- 紙 1- 纖 2- 木 3- 託膜 4- 木託 99-其他 | C |
| DeliveryMethod | Int(1) | 送貨方式(快運字段)默認為0； 0- 自提 1- 送貨上門（不含上樓） 2- 送貨上樓 | C |
返回參數定義：
| 參數名稱 | 類型 | 説明 | 必須要求 |
|---|
| EBusinessID | String(10) | 用户ID | R |
| Order | OrderCode | String(30) | 訂單編號 | R |
| ShipperCode | String(10) | 快遞公司編碼 | R |
| LogisticCode | String(400) | 快遞單號 | R |
| MarkDestination | String(20) | 大頭筆 | O |
| OriginCode | String(20) | 始發地區域編碼 | O |
| OriginName | String(20) | 始發地/始髮網點 | O |
| DestinatioCode | String(20) | 目的地區域編碼 | O |
| DestinatioName | String(20) | 目的地/到達網點 | O |
| SortingCode | String(20) | 分揀編碼 | O |
| PackageCode | String(20) | 集包編碼 | O |
| PackageName | String(50) | 集包地 | O |
| DestinationAllocationCentre | String(50) | 目的地分類 | O |
| Success | Bool(10) | 成功與否(true/false) | R |
| SignWaybillCode | String(15) | 籤回單單號 | O |
| ResultCode | String(5) | 返回編碼 | R |
| Reason | String(50) | 失敗原因 | O |
| UniquerRequestNumber | String(50) | 唯一標識 | R |
| PrintTemplate | String | 面單打印模板內容(html格式) | O |
| EstimatedDeliveryTime | Date | 訂單預計到貨時間yyyy-mm-dd | O |
| SubCount | Int(5) | 子單數量 | O |
| SubOrders | String(400) | 子單單號 | O |
| SubPrintTemplates | String(2000) | 子單模板內容(html格式) | O |
| SignBillPrintTemplate | String(2000) | 籤回單模板內容(html格式) | O |
| ReceiverSafePhone | String(20) | 收件人安全電話 | O |
| SenderSafePhone | String(20) | 收件人安全電話 | O |
| DialPage | String(50) | 撥號頁面網址(轉換成二維碼可掃描撥號) | O |
示例
{ "OrderCode": "012657018199", "ShipperCode": "SF", "PayType": 1, "MonthCode": "1234567890", "ExpType": 1, "Cost": 1.0, "OtherCost": 1.0, "Sender": { "Company": "LV", "Name": "Taylor", "Mobile": "15018442396", "ProvinceName": "上海", "CityName": "上海市", "ExpAreaName": "青浦區", "Address": "明珠路" }, "Receiver": { "Company": "GCCUI", "Name": "Yann", "Mobile": "15018442396", "ProvinceName": "北京", "CityName": "北京市", "ExpAreaName": "朝陽區", "Address": "三里屯街道" }, "Commodity": [ { "GoodsName": "鞋子", "GoodsQuantity": 1, "GoodsWeight": 1.0 }, { "GoodsName": "衣服", "GoodsQuantity": 1, "GoodsWeight": 1.0 }, ], "AddService": [ { "Name": " INSURE ", "Value": "1000" }, { "Name": "COD", "Value": "1020" " CustomerID ": "1234567890" } ], "Weight": 1.0, "Quantity": 1, "Volume": 0.0, "Remark": "小心輕放" }
失敗： { "EBusinessID": "1237100", "ResultCode": "106", "Reason": "該訂單號已下單成功"， "UniquerRequestNumber":"5e66486b-8fbc-4131-b875-9b13d2ad1354" } 成功： { "EBusinessID": "1237100", "Order": { "OrderCode": "012657700387", "ShipperCode": "HTKY", "LogisticCode": "50002498503427", "MarkDestination": "京-朝陽(京-1)", "OriginCode": "200000", "OriginName": "上海分撥中心", "PackageCode": "北京" }, "PrintTemplate":"此處省略打印模板HTML內容", "EstimatedDeliveryTime":"2016-03-06", "Success": true, "ResultCode": "100", "Reason": "成功" }
2.訂單取消接口
請求內容字段定義：
| 參數名稱 | 類型 | 説明 | 是否必須 |
|---|
| ShipperCode | String | 快遞公司編碼 | R |
| OrderCode | String | 訂單編號 | R |
| ExpNo | String | 快遞單號 | R |
| CustomerName | String | 電子面單客户號 | O |
| CustomerPwd | String | 電子面單密碼 | O |
返回參數定義：
| 參數名稱 | 類型 | 説明 | 必須要求 |
|---|
| EBusinessID | String | 用户ID | R |
| Success | Bool | 成功與否(true/false) | R |
| ResultCode | String | 返回編碼 | R |
| Reason | String | 失敗原因 | O |
示例
{ "ShipperCode": "UC", "OrderCode": "TEST201209211045", "ExpNo": "900008664480", "CustomerName": "80238728", "CustomerPwd": "c0bfe0ba86b66bae5426303c53db0a8b" }
{ "EBusinessID": "1237100", "Success": true, "ResultCode": "100" }
3.單號餘量查詢接口
請求內容字段定義：
| 參數名稱 | 類型 | 説明 | 是否必須 |
|---|
| ShipperCode | String | 快遞公司編碼 | R |
| CustomerName | String | 電子面單客户號 | O |
| CustomerPwd | String | 電子面單密碼 | O |
| StationCode | String | 網點編碼 | R |
| StationName | String | 網點名稱 | R |
返回參數定義：
| 參數名稱 | 類型 | 説明 | 必須要求 |
|---|
| EBusinessID | String | 用户ID | R |
| Success | Bool | 成功與否(true/false) | R |
| Reason | String | 失敗原因 | O |
| ResultCode | String | 返回編碼 | R |
| TotalNum | Int(10) | 累計充值數量，電子面單總量(包含已使用/未使用) | O |
| AvailableNum | SInt(10) | 剩餘可用量 | O |
示例
{ "ShipperCode": "UC", "CustomerName": "80238728", "CustomerPwd": "c0bfe0ba86b66bae5426303c53db0a81", "StationCode": "3001", "StationName": "福田網點" }
{ "EBusinessID": "1237100", "Success": true, "Reason": "", "ResultCode": "100", "EorderBalance": { "AvailableNum": 0, "TotalNum": 0 } }
4.客户號申請接口
請求內容字段定義：
| 參數名稱 | 類型 | 説明 | 是否必須 |
|---|
| ShipperCode | String | 快遞公司編碼 | R |
| StationCode | String | 網點編碼 | R |
| StationName | String | 網點名稱 | R |
| ApplyID | String | 申請ID(用户記錄在快遞公司的標識) | O |
| Company | String | 公司名稱 | O |
| Name | String | 聯繫人 | O |
| Tel | String | 電話 | C |
| Mobile | String | 手機 | C |
| ProvinceName | String | 省份 | R |
| ProivnceCode | String | 省份編碼 | O |
| CityName | String | 城市 | R |
| CityCode | String | 城市編碼 | O |
| ExpAreaName | String | 區縣 | R |
| ExpAreaCode | String | 區縣編碼 | O |
| Address | String | 詳細地址 | R |
返回參數定義：
| 參數名稱 | 類型 | 説明 | 必須要求 |
|---|
| EBusinessID | String | 用户ID | R |
| ApplyCode | String | 客户編號 | R |
| Success | Bool | 成功與否(true/false) | R |
| Reason | String | 失敗原因 | O |
| ResultCode | String | 返回編碼 | O |
示例
{ "ShipperCode": "UC", "Company": "快遞鳥", "ApplyID": "1237100", "Name": "hoo123", "Tel": "07558812345", "Mobile": "15612344567", "ProvinceName": "廣東省", "ProivnceCode": "440000", "CityName": "深圳市", "CityCode": "440300", "ExpAreaName": "寶安區", "ExpAreaCode": "440306", "Address": "西鄉1路", "StationCode": "西鄉網點", "StationName": "西鄉網點" }
{ "EBusinessID": "1237100", " ApplyCode ": "test123456", "Success": true, "Reason": "提交申請成功", "ResultCode": "100" }
5.客户號推送接口
請求內容字段定義：
| 參數名稱 | 類型 | 説明 | 是否必須 |
|---|
| ApplyCode | String | 客户編號 | R |
| CustomerName | String | 電子面單客户號 | R |
| CustomerPwd | String | 電子面單密碼 | R |
| StationCode | String | 網點編碼 | R |
| StationName | String | 網點名稱 | R |
返回參數定義：
| 參數名稱 | 類型 | 説明 | 必須要求 |
|---|
| EBusinessID | String | 用户ID | R |
| RequestType | String | 接口指令 | R |
| Success | Bool | 成功與否(true/false) | R |
| Message | String | 返回消息 | O |
示例
{ " ApplyCode ": "test123456", "CustomerName": "80237910", "CustomerPwd": "c0bfe0ba86b66bae5426303c53db0a8b", "StationCode": "閔行八部", "StationName": "閔行八部" }
{ "EBusinessID": "1237100", "Message": "成功", "RequestType": "1117", "Success": true }
粵公安備案號：44030402002993