【分享】添加快遞物流上門取件api接口快速對接指南

上門取件，是電商平台為寄件使用者提供的通過一鍵下單到快遞員，并在2小時上門取件的寄件服務。适用于散客線上寄件、電商退貨上門取件等業務場景；通過API指令由系統自動将消息發送給物流公司和快遞員，由快遞員上門取貨攬件與線上收款；

快遞鳥為解決寄件客戶不用線下找快遞員、不用苦苦等待，通過上門取件服務讓客戶可以輕松選擇約定時間、地點完成寄件需求。

應用場景

1、移動端APP、公衆号、電商等提供的散客寄件下單子產品，通過上門取件直接預約快遞員上門攬件，支援線上支付運費；

2、電商平台、自營電商售後退貨退款時，買家通過平台直接預約快遞員上門攬件，支援線上支付運費；

功能說明

使用流程

一、接口描述/說明

（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正式位址：http://api.kdniao.com/api/OOrderService

請求系統級參數說明

二、接口參數

請求内容字段定義：

傳回參數定義：

三、示例

請求示例 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":"小心輕放"
}

傳回示例：

{
    "EBusinessID":"1237100",
    "Success":true,
    "Order":{
        "OrderCode":"012657018199",
        "KDNOrderCode":"KDN012657018199",
        "ShipperCode":" SF ",
        "LogisticCode":"615123456789"
    },
    "ResultCode":"100",
    "Reason":""
}

接入流程