前期工作就不多说了,快递鸟官网注册,获取key,这些基础步骤以前有提到。
这次我们还是以C#为例来讲解接口。
首先是接口规范:
一、接口描述/说明
上门取件下单接口
(1)此功能是为买家在退货时,提供的一种省心,便捷的物流服务,当买家购买的商品在申请换货或者发起维权投诉时需要退货,不需要自己邮寄商品,由物流公司安排快递员上门取件的一项服务。 (2)下单需指定相应的快递公司编码,格式不对或则编码错误都会返回失败的信息。
(3)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):“application/x-www-form-urlencoded;charset=utf-8”。避免传递中文数据是出现乱码 (4)接口地址:
沙箱地址::8080/kdniaosandbox/gateway/exterfaceInvoke.json
正式地址(不加密):
/api/OOrderService
正式地址(加密):
/api/OOrderService
接口规则
请求报文中不允许出现以下特殊字符: ’ " # & + < > %
预约时提供的收寄方信息必须真实准确。
用户提供的寄件地址若超出快递公司服务范围,则无快递员上门揽件。
预约成功后,仅顺丰会返回快递单号;其他快递公司不会返回快递单号,快递员上门取件时通过其他方式或者手写快递单收件。
因用户原因(如:恶意下单、批量下单长时间不发货等)导致快递公司投诉超过3次,快递鸟将停用此用户接口权限。
通过快递柜预约成功的用户,凭寄件码在3天内(期间会为您保留快递柜空位,快递员不会上门取件)将货物存至快递柜内,存件成功后快递员会取件发货。
目前快递鸟接口支持预约取件的快递公司:顺丰速运、百世快递、中通快递、圆通速递、韵达速递、优速快递、德邦快递、邮政国内标快、EMS、天天快递、邮政快递包裹、宅急送、远成快运(YCWL)、安能快递、天地华宇、增益快递、运东西网、品骏快递、通用物流、壹米滴答、承诺达、安迅物流、快8速运、申通快递、顺心捷达、一智通。
支持预约取件的快递柜:丰巢快递柜(ShipperCode为FCBOX)。
支持预约取件的同城配:闪送、大马鹿。
请求示例:
{"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.0}],"AddService": [{"Name": "COD","Value": "1020"" CustomerID ": "1234567890"}],"Weight": 1.0,"Quantity": 1,"Volume": 0.0,"Remark": "小心轻放"}
返回示例:
{"EBusinessID": "1237100","Success": true,"Order": {"OrderCode": "012657018199","KDNOrderCode": "KDN012657018199"," ShipperCode ": " SF "," LogisticCode ": "615123456789"},"ResultCode": "100","Reason": ""}