快遞鳥一次性對接2000+物流接口

賬號類型	支持快遞公司
無需申請直接打單	順豐速運(SF)、宅急送(ZJS)、聯昊通速遞(LHT)、東方匯(EST365)、溫通物流(WTWL)、遞易家(DYJ)
月結賬號直接打單	德邦(DBL)、EMS(EMS)
線下（網點）申請賬號	順豐速運(SF)、EMS(EMS)、郵政快遞包裹(YZPY)、圓通速遞(YTO)、申通快遞(STO)、德邦快遞(DBL)、中通快遞(ZTO)、韻達速遞(YD)、百世快遞(HTKY)、優速快遞(UC)、跨越速運(KYSY)、豐網速運(FWX)、京東快遞(JD)、速爾快遞(SURE)、信豐物流(XFEX)、品駿快遞(PJ)、承諾達(CND)、極兔速遞(JTSD)、丹鳥物流(DNWL)、蘇寧物流(SNWL)、眾郵快遞(ZYE)、遠成快運(YCWL)、京廣速遞(JGSD)、宅急送(ZJS)、全一快遞(UAPEX)
快運電子面單	騰林物流(TLWL)、百騰物流(BETWL)、天地華宇(HOAU)、德邦快運(DBLKY)、安能快運(ANEKY)、京東快運(JDKY)、龍邦快運(LB)、百世快運(HTKYKY)、中通快運(ZTOKY)、佳吉快運(CNEX)、韻達快運(YDKY)、順心捷達(SX)、京運達(JYD)、宏遞快運(HDWL)、匯霖速運(HUILIN56)、匯森速運(HSSY)、壹米滴答(YMDD)

更多快遞公司，陸續接入中。

下單+打印

a)商家操作發貨時同步訂單的發/收件人信息、貨物信息，通過接口直接發送到快遞公司獲取電子面單單號、大頭筆、電子面單打印模板等信息。通過瀏覽器或CS結構客戶端打印工具進行打印電子面單。

功能說明

使用流程

系統商對接使用流程下載打印組件

商家使用流程

API參數

一、接口描述/說明

1.電子面單接口

（1）電子面單接口是快遞鳥提供給獨立電商、倉儲管理系統、物流供應鏈等物流系統平臺使用的下單接口。
（2）為客戶解決在線發貨需求，商戶通過網絡選擇快遞公司發送請求通知快遞公司有快遞要發貨。
（3）客戶把數據通過此接口轉發到快遞鳥，由快遞鳥為您安排快遞員上門取件的服務。
（4）訂單編號（OrderCode）不可重復提交，重復提交系統會返回具體錯誤代碼。
（5）接口支持的消息接收方式為HTTP POST，請求方法的編碼格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8"。
（6）接口地址： API測試地址：http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址：https://api.kdniao.com/api/EOrderService

請求系統級參數說明：

參數名稱	類型	說明	必須要求
RequestData	String	請求內容需進行URL(utf-8)編碼。請求內容JSON格式，須和DataType一致。	是
EBusinessID	String	商戶ID，請在我的服務頁面查看。	是
RequestType	String	請求指令類型：1007	是
DataSign	String	數據內容簽名：把(請求內容(未編碼)+AppKey)進行MD5加密，然后Base64編碼，最后進行URL(utf-8)編碼。詳細過程請查看Demo。	是
DataType	String	請求、返回數據類型：只支持JSON格式	否

2.訂單取消接口

（1）只支持有成功下單記錄的訂單進行取消。
（2）只支持對未攬件的訂單進行取消。
（3）訂單取消后，訂單號仍不可重復使用。
（4）訂單取消后快遞單號的回收規則以快遞公司為準。
（5）接口地址： API測試地址：http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址：https://api.kdniao.com/api/EOrderService

請求系統級參數說明：

參數名稱	類型	說明	必須要求
RequestData	String	請求內容需進行URL(utf-8)編碼。請求內容JSON格式，須和DataType一致。	是
EBusinessID	String	商戶ID，請在我的服務頁面查看。	是
RequestType	String	請求指令類型：1147	是
DataSign	String	數據內容簽名：把(請求內容(未編碼)+AppKey)進行MD5加密，然后Base64編碼，最后進行URL(utf-8)編碼。詳細過程請查看Demo。	是
DataType	String	請求、返回數據類型：只支持JSON格式	否

3.單號余量查詢接口

請求系統級參數說明：

參數名稱	類型	說明	必須要求
RequestData	String	請求內容需進行URL(utf-8)編碼。請求內容JSON格式，須和DataType一致。	是
EBusinessID	String	商戶ID，請在我的服務頁面查看。	是
RequestType	String	請求指令類型：1127	是
DataSign	String	數據內容簽名：把(請求內容(未編碼)+AppKey)進行MD5加密，然后Base64編碼，最后進行URL(utf-8)編碼。詳細過程請查看Demo。	是
DataType	String	請求、返回數據類型：只支持JSON格式	否

4.客戶號申請接口

請求系統級參數說明：

參數名稱	類型	說明	必須要求
RequestData	String	請求內容需進行URL(utf-8)編碼。請求內容JSON格式，須和DataType一致。	是
EBusinessID	String	商戶ID，請在我的服務頁面查看。	是
RequestType	String	請求指令類型：1127	是
DataSign	String	數據內容簽名：把(請求內容(未編碼)+AppKey)進行MD5加密，然后Base64編碼，最后進行URL(utf-8)編碼。詳細過程請查看Demo。	是
DataType	String	請求、返回數據類型：只支持JSON格式	否

5.客戶號推送接口

（1）推送時會推送RequestType、RequestData和DataSign三個參數 (格式：RequestData={數據}&EBusinessID=1237100 &PushTime=2017-04-18 23:34:29&RequestType=1117) 。

請求系統級參數說明：

參數名稱	類型	說明	必須要求
RequestData	String	請求內容需進行URL(utf-8)編碼。請求內容JSON格式，須和DataType一致。	是
EBusinessID	String	商戶ID，請在我的服務頁面查看。	是
RequestType	String	請求指令類型：1117	是
DataSign	String	數據內容簽名：把(請求內容(未編碼)+AppKey)進行MD5加密，然后Base64編碼，最后進行URL(utf-8)編碼。詳細過程請查看Demo。	是
DataType	String	請求、返回數據類型：只支持JSON格式	否

二、接口參數

1.電子面單接口

請求內容字段定義：

參數名稱		類型	說明	是否必須
MemberID		String（50）	ERP系統、電商平臺等系統或平臺類型用戶的會員ID或店鋪賬號等唯一性標識，用于區分其用戶	否
CustomerName		String(50)	電子面單客戶號，需要下載《快遞鳥電子面單客戶號參數對照表.xlsx》，參考對應字段傳值	否
CustomerPwd		String(30)		否
SendSite		String(30)		否
SendStaff		String(30)		可選
MonthCode		String		可選
CustomArea		String(500)	商家自定義區域	可選
WareHouseID		String(30)	發貨倉編碼	否
TransType		Int(1)	運輸方式 1- 陸運 2- 空運不填默認為1	否
ShipperCode		String(10)	快遞公司編碼詳細編碼參考《快遞鳥接口支持快遞公司編碼.xlsx》	是
LogisticCode		String(30)	快遞單號(僅宅急送可用)	否
ThrOrderCode		String(50)	第三方訂單號 (ShipperCode為JD且ExpType為1時必填)	可選
OrderCode		String(30)	訂單編號(自定義，不可重復)	是
PayType		Int(1)	郵費支付方式:1-現付，2-到付，3-月結，4-第三方支付(僅SF支持)	是
ExpType		String(2)	快遞類型：1-標準快件 ,詳細快遞類型參考《快遞公司快遞業務類型.xlsx》	是
IsReturnSignBill		Int(1)	是否要求簽回單 1- 要求 0-不要求	否
OperateRequire		String(20)	簽回單操作要求(如：簽名、蓋章、身份證復印件等)	否
Cost		Cost Double(5)	快遞運費	否
OtherCost		Double(5)	其他費用	否
Receiver	Company	String(30)	收件人公司	否
	Name	String(30)	收件人	是
	Tel	String(20)	電話與手機，必填一個	是
	Mobile	String(20)	電話與手機，必填一個	是
	PostCode	String(10)	收件人郵編	可選
	ProvinceName	String(20)	收件省 (如廣東省，不要缺少“省”；如是直轄市，請直接傳北京、上海等；如是自治區，請直接傳廣西壯族自治區等)	是
	CityName	String（20）	收件市(如深圳市，不要缺少“市”；如果是市轄區，請直接傳北京市、上海市等)	是
	ExpAreaName	String（20）	收件區/縣(如福田區，不要缺少“區”或“縣”)	是
	Address	String(100)	收件人詳細地址	是
Sender	Company	String(30)	發件人公司	否
	Name	String(30)	發件人	是
	Tel	String(20)	電話與手機，必填一個	是
	Mobile	String(20)	電話與手機，必填一個	是
	PostCode	String(10)	發件地郵編(ShipperCode為EMS、YZPY、YZBK時必填)	可選
	ProvinceName	String(20)	發件省 (如廣東省，不要缺少“省”；如是直轄市，請直接傳北京、上海等；如是自治區，請直接傳廣西壯族自治區等)	是
	CityName	String(20)	發件市(如深圳市，不要缺少“市；如是市轄區，請直接傳北京市、上海市等”)	是
	ExpAreaName	String(20)	發件區/縣(如福田區，不要缺少“區”或“縣”)	是
	Address	String(100)	發件人詳細地址	是
IsNotice		Int(1)	是否通知快遞員上門攬件 0- 通知 1- 不通知不填則默認為1	否
StartDate		Date	上門取貨時間段:"yyyy-MM-dd HH:mm:ss"格式化，本文中所有時間格式相同	否
EndDate		Date	上門取貨時間段:"yyyy-MM-dd HH:mm:ss"格式化，本文中所有時間格式相同	否
Weight		Double(10,3)	包裹總重量kg 當為快運的訂單時必填，不填時快遞鳥將根據各個快運公司要求傳對應的默認值	可選
Quantity		Int(2)	包裹數(最多支持30件) 一個包裹對應一個運單號，如果是大于1個包裹，返回則按照子母件的方式返回母運單號和子運單號	是
Volume		Double(20,3)	包裹總體積m3 當為快運的訂單時必填，不填時快遞鳥將根據各個快運公司要求傳對應的默認值	可選
Remark		String(60)	備注	否
AddServices
AddService	Name	String(20)	增值服務名稱 (數組形式，可以有多個增值服務)	可選
	Value	String(30)	增值服務值	可選
	CustomerID	String(30)	客戶標識（選填）	否
Commoditys
Commodity	GoodsName	String(100)	商品名稱	是
	GoodsCode	String(100)	商品編碼	否
	Goodsquantity	Int(5)	商品數量	否
	GoodsPrice	Double(10)	商品價格	否
	GoodsWeight	Double(10,3)	商品重量kg	否
	GoodsDesc	String(50)	商品描述	否
	GoodsVol	Double(15,3)	商品體積m3	否
IsReturnPrintTemplate		String(1)	返回電子面單模板：0-不需要；1-需要	否
IsSendMessage		Int(1)	是否訂閱短信：0-不需要；1-需要	否
TemplateSize		String(10)	模板規格(默認的模板無需傳值，非默認模板傳對應模板尺寸)	否
PackingType		Int(2)	包裝類型(快運字段)默認為0； 0- 紙 1- 纖 2- 木 3- 托膜 4- 木托 99-其他	可選
DeliveryMethod		Int(1)	送貨方式(快運字段)默認為0； 0- 自提 1- 送貨上門（不含上樓） 2- 送貨上樓	可選

返回參數定義：

參數名稱		類型	說明	必須要求
EBusinessID		String(10)	用戶ID	是
Order	OrderCode	String(30)	訂單編號	是
	ShipperCode	String(10)	快遞公司編碼	是
	LogisticCode	String(400)	快遞單號	是
	MarkDestination	String(20)	大頭筆	否
	OriginCode	String(20)	始發地區域編碼	否
	OriginName	String(20)	始發地/始發網點	否
	DestinatioCode	String(20)	目的地區域編碼	否
	DestinatioName	String(20)	目的地/到達網點	否
	SortingCode	String(20)	分揀編碼	否
	PackageCode	String(20)	集包編碼	否
	PackageName	String(50)	集包地	否
	DestinationAllocationCentre	String(50)	目的地分類	否
Success		Bool(10)	成功與否(true/false)	是
SignWaybillCode		String(15)	簽回單單號	否
ResultCode		String(5)	返回編碼	是
Reason		String(50)	失敗原因	否
UniquerRequestNumber		String(50)	唯一標識	是
PrintTemplate		String	面單打印模板內容(html格式)	否
EstimatedDeliveryTime		Date	訂單預計到貨時間yyyy-mm-dd	否
SubCount		Int(5)	子單數量	否
SubOrders		String(400)	子單單號	否
SubPrintTemplates		String(2000)	子單模板內容(html格式)	否
SignBillPrintTemplate		String(2000)	簽回單模板內容(html格式)	否
ReceiverSafePhone		String(20)	收件人安全電話	否
SenderSafePhone		String(20)	收件人安全電話	否
DialPage		String(50)	撥號頁面網址(轉換成二維碼可掃描撥號)	否

示例

請求示例 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.訂單取消接口

請求內容字段定義：

參數名稱	類型	說明	是否必須
ShipperCode	String	快遞公司編碼	是
OrderCode	String	訂單編號	是
ExpNo	String	快遞單號	是
CustomerName	String	電子面單客戶號	否
CustomerPwd	String	電子面單密碼	否

返回參數定義：

參數名稱	類型	說明	必須要求
EBusinessID	String	用戶ID	是
Success	Bool	成功與否(true/false)	是
ResultCode	String	返回編碼	是
Reason	String	失敗原因	否

示例

請求示例 JSON

{
                        "ShipperCode": "UC",
                    "OrderCode": "TEST201209211045",
                    "ExpNo": "900008664480",
                        "CustomerName": "80238728",
                        "CustomerPwd": "c0bfe0ba86b66bae5426303c53db0a8b"
                    }

返回示例 JSON

{
                          "EBusinessID": "1237100",
                          "Success": true,
                          "ResultCode": "100"
                        }

3.單號余量查詢接口

請求內容字段定義：

參數名稱	類型	說明	是否必須
ShipperCode	String	快遞公司編碼	是
CustomerName	String	電子面單客戶號	否
CustomerPwd	String	電子面單密碼	否
StationCode	String	網點編碼	是
StationName	String	網點名稱	是

返回參數定義：

參數名稱	類型	說明	必須要求
EBusinessID	String	用戶ID	是
Success	Bool	成功與否(true/false)	是
Reason	String	失敗原因	否
ResultCode	String	返回編碼	是
TotalNum	Int(10)	累計充值數量，電子面單總量(包含已使用/未使用)	否
AvailableNum	SInt(10)	剩余可用量	否

示例

請求示例 JSON

{
                    "ShipperCode": "UC",
                    "CustomerName": "80238728",
                    "CustomerPwd": "c0bfe0ba86b66bae5426303c53db0a81",
                    "StationCode": "3001",
                    "StationName": "福田網點"
                }

返回示例 JSON

{
                  "EBusinessID": "1237100",
                  "Success": true,
                  "Reason": "",
                  "ResultCode": "100",
                  "EorderBalance": {
                    "AvailableNum": 0,
                                        "TotalNum": 0
                  }
                }

4.客戶號申請接口

請求內容字段定義：

參數名稱	類型	說明	是否必須
ShipperCode	String	快遞公司編碼	是
StationCode	String	網點編碼	是
StationName	String	網點名稱	是
ApplyID	String	申請ID(用戶記錄在快遞公司的標識)	否
Company	String	公司名稱	否
Name	String	聯系人	否
Tel	String	電話	可選
Mobile	String	手機	可選
ProvinceName	String	省份	是
ProivnceCode	String	省份編碼	否
CityName	String	城市	是
CityCode	String	城市編碼	否
ExpAreaName	String	區縣	是
ExpAreaCode	String	區縣編碼	否
Address	String	詳細地址	是

返回參數定義：

參數名稱	類型	說明	必須要求
EBusinessID	String	用戶ID	是
ApplyCode	String	客戶編號	是
Success	Bool	成功與否(true/false)	是
Reason	String	失敗原因	否
ResultCode	String	返回編碼	否

示例

請求示例 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.客戶號推送接口

請求內容字段定義：

參數名稱	類型	說明	是否必須
ApplyCode	String	客戶編號	是
CustomerName	String	電子面單客戶號	是
CustomerPwd	String	電子面單密碼	是
StationCode	String	網點編碼	是
StationName	String	網點名稱	是

返回參數定義：

參數名稱	類型	說明	必須要求
EBusinessID	String	用戶ID	是
RequestType	String	接口指令	是
Success	Bool	成功與否(true/false)	是
Message	String	返回消息	否

示例

請求示例 JSON

{
                  " ApplyCode ": "test123456",
                  "CustomerName": "80237910",
                  "CustomerPwd": "c0bfe0ba86b66bae5426303c53db0a8b",
                  "StationCode": "閔行八部",
                  "StationName": "閔行八部"
                }

返回示例 JSON

{
                    "EBusinessID": "1237100",
                    "Message": "成功",
                    "RequestType": "1117",
                    "Success": true
                }

接入流程