首頁 > API文檔 > 預約取件API
預約取件API
申請API
預約取件API為用戶提供了在線下單,預約快遞員上門攬件的功能,為用戶解決在線發貨需求。現已支持快遞、快運業務,同城配業務即將上線。已覆蓋國內主流物流公司,更多公司持續接入入中。
應用場景
(1)接口永久免費
(2)對接物流公司官方接口,訂單實時預約,實時返回預約成功或失敗標識
(3)支持自定義預約時間,不遺漏訂單
(4)已支持三通一達(申通不支持)、順豐、EMS、宅急送、德邦、優速等物流公司,并持續增加中
(5)快遞公司會在兩小時內聯系發件人并上門攬件
(6)需實名認證
功能說明
使用流程
API參數
一、接口描述/說明
(1)在線下單接口是快遞鳥提供給獨立電商、倉儲管理系統、物流供應鏈等物流系統平臺使用的下單接口。
(2)為客戶解決在線發貨需求,商戶通過網絡選擇快遞公司發送請求通知快遞公司有快遞要發貨。
(3) 客戶把數據通過此接口轉發到快遞鳥,由快遞鳥為您安排快遞員上門取件的服務。
(4)訂單編號(OrderCode)不可重復提交,重復提交系統會返回具體錯誤代碼。
(5)接口支持的消息接收方式為HTTP POST,請求方法的編碼格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(6)接口地址: API測試地址://sandboxapi.www.sidaiy.com.cn:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址://api.kdniao.com/api/OOrderService
請求系統級參數說明:
參數名稱類型說明必須要求
RequestDataString請求內容需進行URL(utf-8)編碼。請求內容JSON格式,須和DataType一致。R
EBusinessIDString商戶ID,請在我的服務頁面查看。R
RequestTypeString請求指令類型:1001R
DataSignString數據內容簽名:把(請求內容(未編碼)+AppKey)進行MD5加密,然后Base64編碼,最后 進行URL(utf-8)編碼。詳細過程請查看Demo。R
DataTypeString請求、返回數據類型:只支持JSON格式R
備注:R-必填(Required),O-可?。∣ptional),C-報文中該參數在一定條件下可?。–onditional)
二、接口參數
請求內容字段定義:
參數類型說明必須要求
WarehouseIDString倉庫標識O
WarehouseAddressString倉庫地址O
CallBackString商戶標識O
MemberIDString會員標識O
ShipperCodeString快遞公司編碼R
LogisticCodeString快遞單號O
IsNoticeInt發貨方式:0-上門攬件,1-網點自寄,默認為1O
PackingTypeInt包裝類型:包裝類型(快運字段)默認為 0; 0- 紙 1- 纖 2- 木 3- 托膜 4- 木托 99-其他O
IsReturnSignBillInt簽收回單:1-需要,0-不需要,默認為0O
DeliveryMethodInt送貨方式:0-自提,1-送貨上門(不含上樓)2-送貨上樓。(適用于快運類型訂單,物流公司可能會收取費用),默認為0O
OrderCodeString訂單編號R
MonthCodeString月結編碼C
PayTypeInt郵費支付方式:1-現付,2-到付,3-月結,4-第三方支付R
ExpTypeInt快遞類型:1-標準快件R
CostDouble寄件費(運費)O
OtherCostDouble其他費用O
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
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
返回參數定義:
參數名稱類型說明必須要求
EBusinessIDString用戶IDR
OrderOrderCodeString訂單編號R
ShipperCodeString快遞公司編碼R
LogisticCodeString快遞單號O
SuccessBool成功與否R
ResultCodeString結果編碼R
ReasonString失敗原因O
UniquerRequestNumberString唯一標識R
三、示例
請求示例 JSON
{
"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": "小心輕放"
}
返回示例 JSON
失敗:
{
    "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": ""
}
接入流程
demo下載

相關文檔與更多幫助?

30萬+
數十萬客戶的選擇
5.8億次+
日均處理物流數據次數
1450萬+
日均千萬訂單數據處理
418家+
支持全國418家物流商
在線咨詢
商務合作群:
783245476
技術對接群12:
905359308
排三组选370前后关系
400-9633321
免費獲取API