首頁 > API文檔 > 預約取件API
預約取件API為用户提供了在線下單，預約快遞員上門攬件的功能，為用户解決在線發貨需求。現已支持快遞、快運業務，同城配業務即將上線。已覆蓋國內主流物流公司，更多公司持續接入入中。
（1）接口永久免費
（2）對接物流公司官方接口，訂單實時預約，實時返回預約成功或失敗標識
（3）支持自定義預約時間，不遺漏訂單
（4）已支持三通一達（申通不支持）、順豐、EMS、宅急送、德邦、優速等物流公司，並持續增加中
（5）快遞公司會在兩小時內聯繫發件人並上門攬件
（6）需實名認證
一、接口描述/説明
（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/OOrderService
請求系統級參數説明：
| 參數名稱 | 類型 | 説明 | 必須要求 |
|---|
| RequestData | String | 請求內容需進行URL(utf-8)編碼。請求內容JSON格式，須和DataType一致。 | R |
| EBusinessID | String | 商户ID，請在我的服務頁面查看。 | R |
| RequestType | String | 請求指令類型：1001 | R |
| DataSign | String | 數據內容簽名：把(請求內容(未編碼)+AppKey)進行MD5加密，然後Base64編碼，最後 進行URL(utf-8)編碼。詳細過程請查看Demo。 | R |
| DataType | String | 請求、返回數據類型：只支持JSON格式 | R |
備註：R-必填（Required），O-可選（Optional），C-報文中該參數在一定條件下可選（Conditional）
二、接口參數
請求內容字段定義：
| 參數 | 類型 | 説明 | 必須要求 |
|---|
| WarehouseID | String | 倉庫標識 | O |
| WarehouseAddress | String | 倉庫地址 | O |
| CallBack | String | 商户標識 | O |
| MemberID | String | 會員標識 | O |
| ShipperCode | String | 快遞公司編碼 | R |
| LogisticCode | String | 快遞單號 | O |
| IsNotice | Int | 發貨方式：0-上門攬件，1-網點自寄，默認為1 | O |
| PackingType | Int | 包裝類型：包裝類型(快運字段)默認為 0； 0- 紙 1- 纖 2- 木 3- 託膜 4- 木託 99-其他 | O |
| IsReturnSignBill | Int | 簽收回單：1-需要，0-不需要,默認為0 | O |
| DeliveryMethod | Int | 送貨方式：0-自提，1-送貨上門（不含上樓）2-送貨上樓。（適用於快運類型訂單，物流公司可能會收取費用），默認為0 | O |
| OrderCode | String | 訂單編號 | R |
| MonthCode | String | 月結編碼 | C |
| PayType | Int | 郵費支付方式:1-現付，2-到付，3-月結，4-第三方支付 | R |
| ExpType | Int | 快遞類型：1-標準快件 | R |
| Cost | Double | 寄件費（運費） | O |
| OtherCost | Double | 其他費用 | O |
| Receiver | Company | String | 收件人公司 | O |
| Name | String | 收件人 | R |
| Tel | String | 電話與手機，必填一個 | R |
| Mobile | String |
| PostCode | String | 收件人郵編 | O |
| ProvinceName | String | 收件省（如廣東省，不要缺少“省”） | R |
| CityName | String | 收件市（如深圳市，不要缺少“市”） | R |
| ExpAreaName | String | 收件區（如福田區，不要缺少“區”或“縣”） | O |
| Address | String | 收件人詳細地址 | R |
| Sender | Company | String | 發件人公司 | O |
| Name | String | 發件人 | R |
| Tel | String | 電話與手機，必填一個 | R |
| Mobile | String |
| PostCode | String | 發件人郵編 | O |
| ProvinceName | String | 發件省（如廣東省，不要缺少“省”） | R |
| CityName | String | 發件市（如深圳市，不要缺少“市”） | R |
| ExpAreaName | String | 發件區（如福田區，不要缺少“區”或“縣”） | O |
| Address | String | 發件人詳細地址 | R |
| StartDate | String | 上門取貨時間段:"yyyy-MM-dd HH:mm:ss"格式化，本文中所有時間格式相同 | O |
| EndDate | String | O |
| Weight | Double | 物品總重量kg | O |
| Quantity | Int | 件數/包裹數 | O |
| Volume | Double | 物品總體積m3 | O |
| Remark | String | 備註 | O |
| AddServices |
| AddService | Name | String | 增值服務名稱 | O |
| Value | String | 增值服務值 | O |
| CustomerID | String | 客户標識（選填） | O |
| Commoditys |
| Commodity | GoodsName | String | 商品名稱 | R |
| GoodsCode | String | 商品編碼 | O |
| Goodsquantity | Int | 商品數量 | O |
| GoodsPrice | Decimal | 商品價格 | O |
| GoodsWeight | Decimal | 商品重量 | O |
| GoodsDesc | String | 商品描述 | O |
| GoodsVol | Double | 商品體積m3 | O |
返回參數定義：
| 參數名稱 | 類型 | 説明 | 必須要求 |
|---|
| EBusinessID | String | 用户ID | R |
| Order | OrderCode | String | 訂單編號 | R |
| ShipperCode | String | 快遞公司編碼 | R |
| LogisticCode | String | 快遞單號 | O |
| Success | Bool | 成功與否 | R |
| ResultCode | String | 結果編碼 | R |
| Reason | String | 失敗原因 | O |
| UniquerRequestNumber | String | 唯一標識 | R |
三、示例
{ "OrderCode": "012657018199", "ShipperCode": "SF", "PayType": 1, "MonthCode": "7553045845", "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 } ], "AddService": [ { "Name": "COD", "Value": "1020" } ], "Weight": 1.0, "Quantity": 1, "Volume": 0.0, "Remark": "小心輕放" }
失敗： { "EBusinessID": "1237100", "Success": false, "ResultCode": "105", "Reason": "該訂單已經存在，請勿重複操作", "UniquerRequestNumber":"451d3c7c-b428-490a-a4ed-e368f15f6c74" } 成功： { "EBusinessID": "1237100", "Success": true, "Order": { "OrderCode": "012657018199", " ShipperCode ": " SF ", " LogisticCode ": "" }, "ResultCode": "100", "Reason": "" }
粵公安備案號：44030402002993