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

首頁 > API文檔 > 上門取件API
上門取件API
申請API
上門取件,是電商平台為寄件用户提供的通過一鍵下單到快遞員,並在2小時上門取件的寄件服務。適用於散客在線寄件、電商退貨上門取件等業務場景;通過API指令由系統自動將消息發送給物流公司和快遞員,由快遞員上門取貨攬件與在線收款;解決寄件客户不用線下找快遞員、不用苦苦等待,通過上門取件服務讓客户可以輕鬆選擇約定時間、地點完成寄件需求。
應用場景
1、移動端APP、公眾號、電商等提供的散客寄件下單模塊,通過上門取件直接預約快遞員上門攬件,支持在線支付運費;
2、電商平台、自營電商售後退貨退款時,買家通過平台直接預約快遞員上門攬件,支持在線支付運費;
功能説明
使用流程
API參數
一、接口描述/説明
(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
請求系統級參數説明:
參數名稱類型説明必須要求
RequestDataString請求內容需進行URL(utf-8)編碼。請求內容JSON格式,須和DataType一致。R
EBusinessIDString商户ID,請在我的服務頁面查看。R
RequestTypeString請求指令類型:1801R
DataSignString數據內容簽名:把(請求內容(未編碼)+AppKey)進行MD5加密,然後Base64編碼,最後 進行URL(utf-8)編碼。詳細過程請查看Demo。R
DataTypeString請求、返回數據類型:只支持JSON格式R
備註:R-必填(Required),O-可選(Optional),C-報文中該參數在一定條件下可選(Conditional)
二、接口參數
請求內容字段定義:
參數類型説明必須要求
WarehouseIDString倉庫標識O
WarehouseAddressString倉庫地址O
CallBackString商户標識O
MemberIDString會員標識O
OrderCodeString訂單編號R
PayTypeInt郵費支付方式:1-現付,2-到付,3-月結,4-第三方支付R
MonthCodeString月結編碼C
ExpTypeInt快遞類型:1-標準快件R
IsReturnSignBillInt簽收回單:1-需要,0-不需要,默認為0O
ReceiverCompanyString收件人公司O
NameString收件人R
TelString電話與手機,必填一個R
MobileString
PostCodeString收件人郵編O
ProvinceNameString收件省(如廣東省,不要缺少“省”)R
CityNameString收件市(如深圳市,不要缺少“市”)R
ExpAreaNameString收件區(如福田區,不要缺少“區”或“縣”)O
AddressString收件人詳細地址R
SenderCompanyString發件人公司O
NameString發件人R
TelString電話與手機,必填一個R
MobileString
PostCodeString發件人郵編O
ProvinceNameString發件省(如廣東省,不要缺少“省”)R
CityNameString發件市(如深圳市,不要缺少“市”)R
ExpAreaNameString發件區(如福田區,不要缺少“區”或“縣”)O
AddressString發件人詳細地址(實際取件)R
SenderShowAddressString發件人詳細地址O
StartDateString上門取貨時間段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有時間格式相同O
EndDateStringO
WeightDouble物品總重量kgO
QuantityInt件數/包裹數O
VolumeDouble物品總體積m3O
RemarkString備註O
AddServices
AddServiceNameString增值服務名稱O
ValueString增值服務值O
CustomerIDString客户標識(選填)O
Commoditys
CommodityGoodsNameString商品名稱R
GoodsCodeString商品編碼O
GoodsquantityInt商品數量O
GoodsPriceDecimal商品價格O
GoodsWeightDecimal商品重量O
GoodsDescString商品描述O
GoodsVolDouble商品體積m3O
PackingTypeInt包裝類型:包裝類型(快運字段)默認為 0; 0- 紙 1- 纖 2- 木 3- 託膜 4- 木託 99-其他O
DeliveryMethodInt送貨方式:0-自提,1-送貨上門(不含上樓)2-送貨上樓。(適用於快運類型訂單,物流公司可能會收取費用),默認為0O
返回參數定義:
參數名稱類型説明必須要求
EBusinessIDString用户IDR
OrderOrderCodeString訂單編號R
KDNOrderCodeString快遞鳥訂單編號R
ShipperCodeString快遞公司編碼R
LogisticCodeString快遞單號O
SuccessBool成功與否R
ResultCodeString結果編碼R
ReasonString失敗原因O
UniquerRequestNumberString唯一標識R
三、示例
請求示例 JSON
{      "OrderCode":"012657018199",      "ShipperCode":"SF",      "PayType":1,      "MonthCode":"1234567890",      "ExpType":1,      "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          }      ],      "AddService":[          {              "Name":"COD",              "Value":"1020",              "CustomerID":"1234567890"          }      ],      "Weight":1,      "Quantity":1,      "Volume":0,      "Remark":"小心輕放"  }
返回示例 JSON
{      "EBusinessID":"1237100",      "Success":true,      "Order":{          "OrderCode":"012657018199",          "KDNOrderCode":"KDN012657018199",          "ShipperCode":" SF ",          "LogisticCode":"615123456789"      },      "ResultCode":"100",      "Reason":""  }
接入流程
demo下載

相關文檔與更多幫助?

30萬+
數十萬客户的選擇
5.8億次+
日均處理物流數據次數
1450萬+
日均千萬訂單數據處理
600家+
支持全國600+家物流商
在線諮詢
商務合作羣:
1054978381
技術對接羣14:
665031725
技術對接羣13:
489020124
400-9633-321
免費獲取API