電子面單API為使用者提供電子面單下單服務,快遞鳥連接配接多家物流公司,一次接入即可對接多家物流公司電子面單下單通道,為訂單資訊化、标準化提供保障服務。但是有很多朋友不知道快遞鳥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 |