快递鸟一次性对接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测试地址:http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址:http://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-9633321
免费获取API