首頁 > API文檔 > 預(yù)約取件API
預(yù)約取件API為用戶提供了在線下單，預(yù)約快遞員上門攬件的功能，為用戶解決在線發(fā)貨需求。現(xiàn)已支持快遞、快運業(yè)務(wù)，同城配業(yè)務(wù)即將上線。已覆蓋國內(nèi)主流物流公司，更多公司持續(xù)接入入中。
1.此接口用于通知快遞公司快遞員上門攬件，適用電商平臺、打單工具、ERP系統(tǒng)、WEB端、APP移動端、小程序
2.支持自定義預(yù)約時間，實時預(yù)約，實時返回預(yù)約成功或失敗結(jié)果，不遺漏訂單，快遞公司會在兩小時內(nèi)聯(lián)系發(fā)件人并上門攬件
3.已支持順豐速運、百世快遞、中通快遞、圓通速遞、韻達速遞、優(yōu)速快遞、德邦快遞、EMS、宅急送等物流公司，并持續(xù)增加中
一、接口描述/說明
（1）在線下單接口是快遞鳥提供給獨立電商、倉儲管理系統(tǒng)、物流供應(yīng)鏈等物流系統(tǒng)平臺使用的下單接口。
（2）為客戶解決在線發(fā)貨需求，商戶通過網(wǎng)絡(luò)選擇快遞公司發(fā)送請求通知快遞公司有快遞要發(fā)貨。
（3） 客戶把數(shù)據(jù)通過此接口轉(zhuǎn)發(fā)到快遞鳥，由快遞鳥為您安排快遞員上門取件的服務(wù)。
（4）訂單編號（OrderCode）不可重復(fù)提交，重復(fù)提交系統(tǒng)會返回具體錯誤代碼。
（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/OOrderService
請求系統(tǒng)級參數(shù)說明：
| 參數(shù)名稱 | 類型 | 說明 | 必須要求 |
|---|
| RequestData | String | 請求內(nèi)容需進行URL(utf-8)編碼。請求內(nèi)容JSON格式，須和DataType一致。 | 是 |
| EBusinessID | String | 商戶ID，請在我的服務(wù)頁面查看。 | 是 |
| RequestType | String | 請求指令類型：1001 | 是 |
| DataSign | String | 數(shù)據(jù)內(nèi)容簽名：把(請求內(nèi)容(未編碼)+AppKey)進行MD5加密，然后Base64編碼，最后
進行URL(utf-8)編碼。詳細過程請查看Demo。 | 是 |
| DataType | String | 請求、返回數(shù)據(jù)類型：只支持JSON格式 | 是 |
二、接口參數(shù)
請求內(nèi)容字段定義：
| 參數(shù) | 類型 | 說明 | 必須要求 |
|---|
| WarehouseID | String(50) | 倉庫標識(備用字段) | 否 |
| WarehouseAddress | String(50) | 倉庫地址(備用字段) | 否 |
| CallBack | String(50) | 用戶自定義回傳字段 | 否 |
| MemberID | String(50) | ERP系統(tǒng)、電商平臺等系統(tǒng)或平臺類型用戶的會員ID或店鋪賬號等唯一性標識，用于區(qū)分其用戶 | 否 |
| ShipperCode | String(20) | 快遞公司編碼詳細編碼參考《快遞鳥接口支持快遞公司編碼.xlsx》 | 是 |
| FcBoxShipperCode | String(20) | 選擇快遞柜支持預(yù)約的快遞公司
(ShipperCode為FCBOX時必填)
SF：順豐速運(僅支持ExpType為1和2兩種業(yè)務(wù)類型)
ZTO：中通快遞
STO：申通快遞
YD：韻達速遞
EMS：EMS | 可選 |
| LogisticCode | String(30) | 快遞單號 | 否 |
| ThrOrderCode | String(50) | 第三方訂單號，即電商平臺原始訂單號(ShipperCode=SF且需要核銷原訂單時必傳) | 可選 |
| OrderCode | String(30) | 訂單編號(自定義，不可重復(fù)) | 是 |
| PayType | Int(1) | 運費支付方式：
1-現(xiàn)付，2-到付，3-月結(jié)，4-第三方付(僅SF支持) | 是 |
| MonthCode | String(20) | 月結(jié)編號 | 可選 |
| ExpType | Int(2) | 詳細快遞類型參考《快遞公司快遞業(yè)務(wù)類型.xlsx》 | 是 |
| IsReturnSignBill | Int(1) | 是否要求簽回單
0-不要求，1-要求 | 否 |
| Cost | Double(5) | 快遞運費 | 否 |
| OtherCost | Double(5) | 其他費用 | 否 |
| Receiver | Company | String(30) | 收件人公司 | 否 |
| Name | String(30) | 收件人 | 是 |
| Tel | String(20) | 電話與手機，必填一個 | 是 |
| Mobile | String(20) |
| PostCode | String | 收件地郵編(ShipperCode為EMS、YZPY、YZBK時必填) | 可選 |
| ProvinceName | String(20) | 收件省
(如廣東省，不要缺少“省”；
如是直轄市，請直接傳北京、上海等；
如是自治區(qū)，請直接傳廣西壯族自治區(qū)等) | 是 |
| CityName | String(20) | 收件市(如深圳市，不要缺少“市；
如是市轄區(qū)，請直接傳北京市、上海市等”) | 是 |
| ExpAreaName | String(20) | 收件區(qū)/縣(如福田區(qū)，不要缺少“區(qū)”或“縣”) | 是 |
| Address | String(100) | 收件人詳細地址(不用傳省市區(qū)) | 是 |
| Sender | Company | String(30) | 發(fā)件人公司 | 否 |
| Name | String(30) | 發(fā)件人 | 是 |
| Tel | String(20) | 電話與手機，必填一個 | 是 |
| Mobile | String(20) |
| PostCode | String(10) | 發(fā)件地郵編(ShipperCode為EMS、YZPY、YZBK時必填) | 可選 |
| ProvinceName | String(20) | 發(fā)件省
(如廣東省，不要缺少“省”；
如是直轄市，請直接傳北京、上海等；
如是自治區(qū)，請直接傳廣西壯族自治區(qū)等) | 是 |
| CityName | String(20) | 發(fā)件市(如深圳市，不要缺少“市；
如是市轄區(qū)，請直接傳北京市、上海市等”) | 是 |
| ExpAreaName | String(20) | 發(fā)件區(qū)/縣(如福田區(qū)，不要缺少“區(qū)”或“縣”) | 是 |
| Address | String(100) | 發(fā)件人詳細地址(不用傳省市區(qū)) | 是 |
| StartDate | String(32) | 上門攬件開始時間，示例：2021-01-01 09:00:00 | 否 |
| EndDate | String(32) | 上門攬件結(jié)束時間，示例：2021-01-01 17:00:00 | 否 |
| Weight | Double(10,3) | 包裹總重量kg，當選擇IsInstallService時，必填 | 可選 |
| Quantity | Int(2) | 包裹數(shù)，一個包裹對應(yīng)一個運單號，如果是大于1個包裹，返回則按照子母件的方式返回母運單號和子運單號 | 是 |
| Volume | Double(20,3) | 包裹總體積m3 | 否 |
| Remark | String(20) | 備注 | 否 |
| Commoditys |
| Commodity | GoodsName | String(100) | 商品名稱 | 是 |
| GoodsCode | String(20) | 商品編碼 | 否 |
| Goodsquantity | Int(5) | 商品件數(shù) | 否 |
| GoodsPrice | Double(10) | 商品價格 | 否 |
| GoodsWeight | Double(10,3) | 商品重量kg | 否 |
| GoodsDesc | String(50) | 商品描述 | 否 |
| GoodsVol | Double(15,3) | 商品體積m3 | 否 |
| InstallTypeCode | String(50) | 需送裝時，必傳安裝品類編碼(僅支持ShipperCode為SF) | 可選 |
| IsInstallService | Int(1) | 送裝服務(wù)(僅支持ShipperCode為SF)；
0-非安裝訂單，1-送裝分離，2-送裝一體，不填默認為0 | 可選 |
| PackingType | Int(2) | 包裝類型(快運字段)；
0-紙，1-纖，2-木，3-托膜，4-木托，99-其他 | 可選 |
| DeliveryMethod | Int(1) | 送貨方式(快運字段)；
自提，1-送貨上門（不含上樓），2-送貨上樓。 | 可選 |
返回參數(shù)定義：
| 參數(shù)名稱 | 類型(字符長度) | 描述 | 是否必須 |
|---|
| EBusinessID | String(10) | 用戶ID | 是 |
| Order | OrderCode | String(30) | 訂單編號 | 是 |
| ShipperCode | String(10) | 快遞公司編碼 | 是 |
| LogisticCode | String(30) | 快遞單號 | 否 |
| Success | Bool(10) | 成功與否(true/false) | 是 |
| ResultCode | String(5) | 返回編號 | 是 |
| Reason | String(50) | 失敗原因 | 否 |
| UniquerRequestNumber | String(50) | 唯一標識 | 是 |
三、示例
{
"OrderCode": "012657018199",
"ShipperCode": "SF",
"PayType": 1,
"MonthCode": "1234567890",
"ExpType": 1,
"Cost": 1.0,
"OtherCost": 1.0,
"Sender": {
"Company": "LV",
"Name": "快遞鳥",
"Mobile": "15018442396",
"ProvinceName": "上海",
"CityName": "上海市",
"ExpAreaName": "青浦區(qū)",
"Address": "明珠路"
},
"Receiver": {
"Company": "GCCUI",
"Name": "Yann",
"Mobile": "15018442396",
"ProvinceName": "北京",
"CityName": "北京市",
"ExpAreaName": "朝陽區(qū)",
"Address": "三里屯街道"
},
"Commodity": [
{
"GoodsName": "鞋子",
"Goodsquantity": 1,
"GoodsWeight": 1.0
}
],
"AddService": [
{
"Name": "COD",
"Value": "1020",
"CustomerID": "1234567890"
}
],
"Weight": 1.0,
"Quantity": 1,
"Volume": 0.0,
"Remark": "小心輕放"
}
{
"EBusinessID": "1237100",
"Success": true,
"Order": {
"OrderCode": "012657018199",
" ShipperCode ": " SF ",
" LogisticCode ": "615123456789"
},
"ResultCode": "100",
"Reason": ""
}
物流查詢類增值服務(wù)
行業(yè)解決方案
通用解決方案
快遞
航空貨運
快運
鐵路貨運
國際海運
整車貨運
跨境小包
即時配送
400-8699-100
粵公安備案號：44030402002993
