首頁 > API文檔 > 電子面單API
電子面單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結構客戶端打印工具進行打印電子面單。
功能說明
使用流程
系統商對接使用流程下載打印組件
商家使用流程
API參數
一、接口描述/說明
1.電子面單接口
(1)電子面單接口是快遞鳥提供給獨立電商、倉儲管理系統、物流供應鏈等物流系統平臺使用的下單接口。
(2)為客戶解決在線發貨需求,商戶通過網絡選擇快遞公司發送請求通知快遞公司有快遞要發貨。
(3) 客戶把數據通過此接口轉發到快遞鳥,由快遞鳥為您安排快遞員上門取件的服務。
(4)訂單編號(OrderCode)不可重復提交,重復提交系統會返回具體錯誤代碼。
(5)接口支持的消息接收方式為HTTP POST,請求方法的編碼格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(6)接口地址: API測試地址://sandboxapi.www.sidaiy.com.cn:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址://api.kdniao.com/api/EOrderService
請求系統級參數說明:
參數名稱類型說明必須要求
RequestDataString請求內容需進行URL(utf-8)編碼。請求內容JSON格式,須和DataType一致。R
EBusinessIDString商戶ID,請在我的服務頁面查看。R
RequestTypeString請求指令類型:1007R
DataSignString數據內容簽名:把(請求內容(未編碼)+AppKey)進行MD5加密,然后Base64編碼,最后 進行URL(utf-8)編碼。詳細過程請查看Demo。R
DataTypeString請求、返回數據類型:只支持JSON格式O
備注:R-必填(Required),O-可?。∣ptional),C-報文中該參數在一定條件下可?。–onditional)
2.訂單取消接口
(1)只支持有成功下單記錄的訂單進行取消。
(2)只支持對未攬件的訂單進行取消。
(3)訂單取消后,訂單號仍不可重復使用。
(4)訂單取消后快遞單號的回收規則以快遞公司為準。
(5)接口地址: API測試地址://sandboxapi.www.sidaiy.com.cn:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址://api.kdniao.com/api/EOrderService
請求系統級參數說明:
參數名稱類型說明必須要求
RequestDataString請求內容需進行URL(utf-8)編碼。請求內容JSON格式,須和DataType一致。R
EBusinessIDString商戶ID,請在我的服務頁面查看。R
RequestTypeString請求指令類型:1147R
DataSignString數據內容簽名:把(請求內容(未編碼)+AppKey)進行MD5加密,然后Base64編碼,最后 進行URL(utf-8)編碼。詳細過程請查看Demo。R
DataTypeString請求、返回數據類型:只支持JSON格式O
備注:R-必填(Required),O-可?。∣ptional),C-報文中該參數在一定條件下可?。–onditional)
3.單號余量查詢接口
請求系統級參數說明:
參數名稱類型說明必須要求
RequestDataString請求內容需進行URL(utf-8)編碼。請求內容JSON格式,須和DataType一致。R
EBusinessIDString商戶ID,請在我的服務頁面查看。R
RequestTypeString請求指令類型:1127R
DataSignString數據內容簽名:把(請求內容(未編碼)+AppKey)進行MD5加密,然后Base64編碼,最后 進行URL(utf-8)編碼。詳細過程請查看Demo。R
DataTypeString請求、返回數據類型:只支持JSON格式O
備注:R-必填(Required),O-可?。∣ptional),C-報文中該參數在一定條件下可?。–onditional)
4.客戶號申請接口
請求系統級參數說明:
參數名稱類型說明必須要求
RequestDataString請求內容需進行URL(utf-8)編碼。請求內容JSON格式,須和DataType一致。R
EBusinessIDString商戶ID,請在我的服務頁面查看。R
RequestTypeString請求指令類型:1127R
DataSignString數據內容簽名:把(請求內容(未編碼)+AppKey)進行MD5加密,然后Base64編碼,最后 進行URL(utf-8)編碼。詳細過程請查看Demo。R
DataTypeString請求、返回數據類型:只支持JSON格式O
備注:R-必填(Required),O-可?。∣ptional),C-報文中該參數在一定條件下可?。–onditional)
5.客戶號推送接口
(1)推送時會推送RequestType、RequestData和DataSign三個參數 (格式:RequestData={數據}&EBusinessID=1237100 &PushTime=2017-04-18 23:34:29&RequestType=1117) 。
請求系統級參數說明:
參數名稱類型說明必須要求
RequestDataString請求內容需進行URL(utf-8)編碼。請求內容JSON格式,須和DataType一致。R
EBusinessIDString商戶ID,請在我的服務頁面查看。R
RequestTypeString請求指令類型:1117R
DataSignString數據內容簽名:把(請求內容(未編碼)+AppKey)進行MD5加密,然后Base64編碼,最后 進行URL(utf-8)編碼。詳細過程請查看Demo。R
DataTypeString請求、返回數據類型:只支持JSON格式O
備注:R-必填(Required),O-可?。∣ptional),C-報文中該參數在一定條件下可?。–onditional)
二、接口參數
1.電子面單接口
請求內容字段定義:
參數名稱類型說明是否必須
MemberIDString(50)ERP系統、電商平臺等系統或平臺類型用戶的會員ID或店鋪賬號等唯一性標識,用于區分其用戶O
CustomerNameString(50)電子面單客戶號,需要下載《快遞鳥電子面單客戶號參數對照表.xlsx》,參考對應字段傳值O
CustomerPwdString(30)O
SendSiteString(30)O
SendStaffString(30)C
MonthCodeStringC
CustomAreaString(500)商家自定義區域C
WareHouseIDString(30)發貨倉編碼O
TransTypeInt(1)運輸方式 1- 陸運 2- 空運 不填默認為1O
ShipperCodeString(10)快遞公司編碼 詳細編碼參考《2019快遞鳥接口支持快遞公司編碼.xlsx》R
LogisticCodeString(30)快遞單號(僅宅急送可用)O
ThrOrderCodeString(50)第三方訂單號 (ShipperCode為JD且ExpType為1時必填)C
OrderCodeString(30)訂單編號(自定義,不可重復)R
PayTypeInt(1)郵費支付方式:1-現付,2-到付,3-月結,4-第三方支付(僅SF支持)R
ExpTypeString(2)快遞類型:1-標準快件 ,詳細快遞類型參考《快遞公司快遞業務類型.xlsx》R
IsReturnSignBillInt(1)是否要求簽回單 1- 要求 0-不要求O
OperateRequireString(20)簽回單操作要求(如:簽名、蓋章、身份證復印件等)O
CostCost Double(5)快遞運費O
OtherCostDouble(5)其他費用O
ReceiverCompanyString(30)收件人公司O
NameString(30)收件人R
TelString(20)電話與手機,必填一個R
MobileString(20)
PostCodeString(10)收件人郵編c
ProvinceNameString(20)收件省 (如廣東省,不要缺少“省”;如是直轄市,請直接傳北京、上海等; 如是自治區,請直接傳廣西壯族自治區等)R
CityNameString(20)收件市(如深圳市,不要缺少“市”; 如果是市轄區,請直接傳北京市、上海市等)R
ExpAreaNameString(20)收件區/縣(如福田區,不要缺少“區”或“縣”)R
AddressString(100)收件人詳細地址R
SenderCompanyString(30)發件人公司O
NameString(30)發件人R
TelString(20)電話與手機,必填一個R
MobileString(20)
PostCodeString(10)發件地郵編(ShipperCode為EMS、YZPY、YZBK時必填)C
ProvinceNameString(20)發件省 (如廣東省,不要缺少“省”; 如是直轄市,請直接傳北京、上海等; 如是自治區,請直接傳廣西壯族自治區等)R
CityNameString(20)發件市(如深圳市,不要缺少“市; 如是市轄區,請直接傳北京市、上海市等”)R
ExpAreaNameString(20)發件區/縣(如福田區,不要缺少“區”或“縣”)R
AddressString(100)發件人詳細地址R
IsNoticeInt(1)是否通知快遞員上門攬件 0- 通知 1- 不通知 不填則默認為1O
StartDateDate上門取貨時間段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有時間格式相同O
EndDateDateO
WeightDouble(10,3)包裹總重量kg 當為快運的訂單時必填,不填時快遞鳥將根據各個快運公司要求傳對應的默認值C
QuantityInt(2)包裹數(最多支持30件) 一個包裹對應一個運單號,如果是大于1個包裹,返回則按照子母件的方式返回母運單號和子運單號R
VolumeDouble(20,3)包裹總體積m3 當為快運的訂單時必填,不填時快遞鳥將根據各個快運公司要求傳對應的默認值C
RemarkString(60)備注O
AddServices
AddServiceNameString(20)增值服務名稱
(數組形式,可以有多個增值服務)
C
ValueString(30)增值服務值C
CustomerIDString(30)客戶標識(選填)O
Commoditys
CommodityGoodsNameString(100)商品名稱R
GoodsCodeString(100)商品編碼O
GoodsquantityInt(5)商品數量O
GoodsPriceDouble(10)商品價格O
GoodsWeightDouble(10,3)商品重量kgO
GoodsDescString(50)商品描述O
GoodsVolDouble(15,3)商品體積m3O
IsReturnPrintTemplateString(1)返回電子面單模板:0-不需要;1-需要O
IsSendMessageInt(1)是否訂閱短信:0-不需要;1-需要O
TemplateSizeString(10)模板規格(默認的模板無需傳值,非默認模板傳對應模板尺寸)O
PackingTypeInt(2)包裝類型(快運字段)默認為0; 0- 紙 1- 纖 2- 木 3- 托膜 4- 木托 99-其他C
DeliveryMethodInt(1)送貨方式(快運字段)默認為0; 0- 自提 1- 送貨上門(不含上樓) 2- 送貨上樓C
返回參數定義:
參數名稱類型說明必須要求
EBusinessIDString(10)用戶IDR
OrderOrderCodeString(30)訂單編號R
ShipperCodeString(10)快遞公司編碼R
LogisticCodeString(400)快遞單號R
MarkDestinationString(20)大頭筆O
OriginCodeString(20)始發地區域編碼O
OriginNameString(20)始發地/始發網點O
DestinatioCodeString(20)目的地區域編碼O
DestinatioNameString(20)目的地/到達網點O
SortingCodeString(20)分揀編碼O
PackageCodeString(20)集包編碼O
PackageNameString(50)集包地O
DestinationAllocationCentreString(50)目的地分類O
SuccessBool(10)成功與否(true/false)R
SignWaybillCodeString(15)簽回單單號O
ResultCodeString(5)返回編碼R
ReasonString(50)失敗原因O
UniquerRequestNumberString(50)唯一標識R
PrintTemplateString面單打印模板內容(html格式)O
EstimatedDeliveryTimeDate訂單預計到貨時間yyyy-mm-ddO
SubCountInt(5)子單數量O
SubOrdersString(400)子單單號O
SubPrintTemplatesString(2000)子單模板內容(html格式)O
SignBillPrintTemplateString(2000)簽回單模板內容(html格式)O
ReceiverSafePhoneString(20)收件人安全電話O
SenderSafePhoneString(20)收件人安全電話O
DialPageString(50)撥號頁面網址(轉換成二維碼可掃描撥號)O
示例
請求示例 JSON
{
                          "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": "小心輕放"
                        }
返回示例 JSON
失敗:
                           {
                              "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.訂單取消接口
請求內容字段定義:
參數名稱類型說明是否必須
ShipperCodeString快遞公司編碼R
OrderCodeString訂單編號R
ExpNoString快遞單號R
CustomerNameString電子面單客戶號O
CustomerPwdString電子面單密碼O
返回參數定義:
參數名稱類型說明必須要求
EBusinessIDString用戶IDR
SuccessBool成功與否(true/false)R
ResultCodeString返回編碼R
ReasonString失敗原因O
示例
請求示例 JSON
{
                        "ShipperCode": "UC",
                    "OrderCode": "TEST201209211045",
                    "ExpNo": "900008664480",
                        "CustomerName": "80238728",
                        "CustomerPwd": "c0bfe0ba86b66bae5426303c53db0a8b"
                    }
返回示例 JSON
{
                          "EBusinessID": "1237100",
                          "Success": true,
                          "ResultCode": "100"
                        }
3.單號余量查詢接口
請求內容字段定義:
參數名稱類型說明是否必須
ShipperCodeString快遞公司編碼R
CustomerNameString電子面單客戶號O
CustomerPwdString電子面單密碼O
StationCodeString網點編碼R
StationNameString網點名稱R
返回參數定義:
參數名稱類型說明必須要求
EBusinessIDString用戶IDR
SuccessBool成功與否(true/false)R
ReasonString失敗原因O
ResultCodeString返回編碼R
TotalNumInt(10)累計充值數量,電子面單總量(包含已使用/未使用)O
AvailableNumSInt(10)剩余可用量O
示例
請求示例 JSON
{
                    "ShipperCode": "UC",
                    "CustomerName": "80238728",
                    "CustomerPwd": "c0bfe0ba86b66bae5426303c53db0a81",
                    "StationCode": "3001",
                    "StationName": "福田網點"
                }
返回示例 JSON
{
                  "EBusinessID": "1237100",
                  "Success": true,
                  "Reason": "",
                  "ResultCode": "100",
                  "EorderBalance": {
                    "AvailableNum": 0,
                                        "TotalNum": 0
                  }
                }
4.客戶號申請接口
請求內容字段定義:
參數名稱類型說明是否必須
ShipperCodeString快遞公司編碼R
StationCodeString網點編碼R
StationNameString網點名稱R
ApplyIDString申請ID(用戶記錄在快遞公司的標識)O
CompanyString公司名稱O
NameString聯系人O
TelString電話C
MobileString手機C
ProvinceNameString省份R
ProivnceCodeString省份編碼O
CityNameString城市R
CityCodeString城市編碼O
ExpAreaNameString區縣R
ExpAreaCodeString區縣編碼O
AddressString詳細地址R
返回參數定義:
參數名稱類型說明必須要求
EBusinessIDString用戶IDR
ApplyCodeString客戶編號R
SuccessBool成功與否(true/false)R
ReasonString失敗原因O
ResultCodeString返回編碼O
示例
請求示例 JSON
{
    "ShipperCode": "UC",
    "Company": "快遞鳥",
    "ApplyID": "1237100",
    "Name": "hoo123",
    "Tel": "07558812345",
    "Mobile": "15612344567",
    "ProvinceName": "廣東省",
    "ProivnceCode": "440000",
    "CityName": "深圳市",
    "CityCode": "440300",
    "ExpAreaName": "寶安區",
    "ExpAreaCode": "440306",
    "Address": "西鄉1路",
    "StationCode": "西鄉網點",
    "StationName": "西鄉網點"
}
返回示例 JSON
{
  "EBusinessID": "1237100",
  " ApplyCode ": "test123456",
  "Success": true,
  "Reason": "提交申請成功",
  "ResultCode": "100"
}
5.客戶號推送接口
請求內容字段定義:
參數名稱類型說明是否必須
ApplyCodeString客戶編號R
CustomerNameString電子面單客戶號R
CustomerPwdString電子面單密碼R
StationCodeString網點編碼R
StationNameString網點名稱R
返回參數定義:
參數名稱類型說明必須要求
EBusinessIDString用戶IDR
RequestTypeString接口指令R
SuccessBool成功與否(true/false)R
MessageString返回消息O
示例
請求示例 JSON
{
                  " ApplyCode ": "test123456",
                  "CustomerName": "80237910",
                  "CustomerPwd": "c0bfe0ba86b66bae5426303c53db0a8b",
                  "StationCode": "閔行八部",
                  "StationName": "閔行八部"
                }
返回示例 JSON
{
                    "EBusinessID": "1237100",
                    "Message": "成功",
                    "RequestType": "1117",
                    "Success": true
                }
接入流程
demo下載

相關文檔與更多幫助?

30萬+
數十萬客戶的選擇
5.8億次+
日均處理物流數據次數
1450萬+
日均千萬訂單數據處理
418家+
支持全國418家物流商
在線咨詢
商務合作群:
783245476
技術對接群12:
489020124
排三组选370前后关系
400-9633321
免費獲取API