【分享】添加快递物流上门取件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":""
}

接入流程