近几年来,我国电子商务交易规模越来越大,线上订单越来越多,退换货的情况也越来越常见。退换货环节是线上购物过程中的重要一环,也是体现电商平台与商家服务水平的重要方面。同时,退换货也是电商平台、商家与消费者之间最容易产生纠纷的环节。为了保障这个环节的服务,电商平台推出了退换货上门取件业务。退换货上门取件是为买家在退货时,提供的一种省心,便捷的物流服务,当买家购买的商品在申请换货或者发起维权投诉时需要退货,不需要自己邮寄商品,由物流公司安排快递员上门取件的一项服务。
1.接口功能说明
2.完成前期准备工作
3.API接口
4.请求参数(Headers)
5.请求参数(Body)
6.请求参数(示例)
7.返回参数(Return)
8.返回报文(示例)
9.完整请求的报文(URL编码)
10.解码后的报文
11.分步讲解(C#版本)
12.关于签名
接口规则
名称
类型(字符长度)
是否必须
描述
WarehouseID
String(50)
O
仓库标识(备用字段)
WarehouseAddress
仓库地址(备用字段)
Callback
用户自定义回传字段
MemberID
ERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户
OrderCode
String(30)
R
订单编号(自定义,不可重复)
PayType
Int(1)
运费支付方式:
1-现付,2-到付,3-月结,4-第三方付(仅SF支持)
MonthCode
String(20)
C
月结编号
ExpType
Int(2)
快递类型:
1-标准路线(默认传1)
IsReturnSignBill
是否要求签回单
0-不要求,1-要求
Receiver
Company
收件人公司
Name
收件人
Tel
Mobile
PostCode
String(10)
收件地邮编
ProvinceName
收件省
(如广东省,不要缺少“省”;如是直辖市,请直接传北京、上海等;
如是自治区,请直接传广西壮族自治区等)
CityName
收件市(如深圳市,不要缺少“市;
如是市辖区,请直接传北京市、上海市等”)
ExpAreaName
收件区/县(如福田区,不要缺少“区”或“县”)
Address
String(100)
收件人详细地址
Sender
发件人公司
发件人
发件地邮编
发件省
(如广东省,不要缺少“省”;
如是直辖市,请直接传北京、上海等;
发件市(如深圳市,不要缺少“市;
发件区/县(如福田区,不要缺少“区”或“县”)
发件人详细地址(实际取件)
SenderShowAddress
发件人详细地址<发件地址>
StartDate
Date
EndDate
Weight
Double(10,3)
包裹总重量kg
Quantity
包裹数,一个包裹对应一个运单号,如果是大于1个包裹,返回则按照子母件的方式返回母运单号和子运单号
Volume
Double(20,3)
包裹总体积m3
Remark
String(60)
备注
AddService
Value
增值服务值
CustomerID
客户标识
Commodity
GoodsName
商品名称
GoodsCode
商品编码
Goodsquantity
Int(5)
商品件数
GoodsPrice
Double(10)
商品价格
GoodsWeight
商品重量kg
GoodsDesc
商品描述
GoodsVol
Double(15,3)
商品体积m3
PackingType
包装类型(快运字段)默认为0;
0-纸,1-纤,2-木,3-托膜,4-木托,99-其他
DeliveryMethod
送货方式(快运字段)默认为0;
0-自提,1-送货上门(不含上楼),2-送货上楼
{"OrderCode":"012657018199","PayType":"1","MonthCode":"1234567890","ExpType":"1","Sender":{"Name":"Taylor","Mobile":"15018442396","ProvinceName":"上海","CityName":"上海市","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":"小心轻放","StartDate":"2020-05-1911:00:00","EndDate":"2020-05-1915:00:00"}
EBusinessID
用户ID
Order.OrderCode
订单编号
Order.KDNOrderCode
快递鸟订单编号
Order.ShipperCode
快递公司编码
Order.LogisticCode
快递单号
Success
Bool(10)
成功与否(true/false)
ResultCode
String(5)
返回编号
Reason
失败原因
UniquerRequestNumber
唯一标识
{"EBusinessID":"test1617571","Success":true,"Order":{"OrderCode":"112657018199","KDNOrderCode":"KDN10200519103057","ShipperCode":"JD"},"ResultCode":"100","Reason":"","UniquerRequestNumber":"1ed104ea-ff57-404f-8e12-59e1f4636920"}
RequestData={"PayType":1,"ExpType":1,"ShipperCode":"SF","OrderCode":"300008886539888","IsNotice":1,"IsReturnPrintTemplate":1,"Commodity":[{"GoodsName":"其他","Goodsquantity":1,"GoodsWeight":0}],"Sender":{"Name":"王宝剑","Mobile":"13988888888","ProvinceName":"北京市","CityName":"北京市","ExpAreaName":"西城区","Address":"北京市西城区西直门南小街国英1号1020"},"Receiver":{"Name":"刘小刀","Mobile":"18809999999","ProvinceName":"广东省","CityName":"深圳市","ExpAreaName":"福田区","Address":"广东省深圳市福田区华宝一号大厦"}}&EBusinessID=test1617571&RequestType=1007&DataSign=ZDhhOTU2OTcxMWI1NGFiNTBmMzQ5NjMwNzYxZmEyMzk=&DataType=2
请求数据包结构
快递鸟和第三方电子商务公司系统进行对接,有一定的安全机制。采用IP认证加签名的方式对接,具体方案如下: