上门取件API-取消接口
上一篇文章我们介绍了如何对接上门取件接口，实际业务会存在，取消操作功能，我下的订单，由于多方原因需要取消下单，为此快递鸟也提供了取消上门取件的接口，这次，我们来讲解一下如何调用。
接口规范：
一、接口描述/说明
1. 上门取件取消接口
（1）此接口用于取消“上门取件接口”预约成功的订单。
（2）下单需指定相应的快递公司编码，格式不对或则编码错误都会返回失败的信息。
（3）接口支持的消息接收方式为HTTP POST，请求方法的编码格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8"。避免传递中文数据是出现乱码
（4）接口地址：
沙箱地址：http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
正式地址(不加密)：
http://api.kdniao.com/api/OOrderService
正式地址(加密)：
https://api.kdniao.com/api/OOrderService
接口规则
- 此接口只支持取消通过预约取件接口下单成功的订单；
- 只支持取消未揽件的订单；
- 订单取消后，订单号仍不可重复使用；
- 订单取消后快递单号的回收规则以快递公司为准。
取消接口目前只支持以下快递公司：
顺丰速运、优速快递、韵达速递、德邦快递、中通快递、百世快递、承诺达、申通快递、壹米滴答。
接口数据包结构：
图例 - 数据包结构 (系统级参数{应用级参数})
系统级参数
|
参数名称 |
类型 |
说明 |
必须要求 |
|
RequestData |
String |
请求内容需进行URL(utf-8)编码。请求内容JSON格式，须和DataType一致。 |
R |
|
EBusinessID |
String |
商户ID，请在我的服务页面查看。 |
R |
|
RequestType |
String |
请求指令类型：1802 |
R |
|
DataSign |
String |
数据内容签名：把(请求内容(未编码)+AppKey)进行MD5加密，然后Base64编码，最后 进行URL(utf-8)编码。详细过程请查看Demo。 |
R |
|
DataType |
String |
请求、返回数据类型：2-json； |
R |
备注：R-必填（Required），O-可选（Optional），C-报文中该参数在一定条件下可选（Conditional）
前面介绍过快递即时查询接口，订阅推送接口，我们发现快递鸟提供的所有接口统一使用同一结构，系统级参数都一样，根据不同的请求接口指令接入不同的接口，取消接口的指令是 1802
应用级参数
|
名称 |
类型(字符长度) |
是否必须 |
描述 |
|
ShipperCode |
String(20) |
R |
快递公司编码 详细编码参考《快递鸟接口支持快递公司编码.xlsx》 |
|
OrderCode |
String(30) |
R |
订单编号(自定义，不可重复) |
|
LogisticCode |
String(30) |
O |
快递单号 |
|
Reason |
String(100) |
O |
取消原因 |
请求示例:
|
{ "OrderCode": "012657018199", "ShipperCode": "SF", } |
返回参数
|
名称 |
类型(字符长度) |
是否必须 |
描述 |
|
EBusinessID |
String(10) |
R |
用户ID |
|
Success |
Bool(10) |
R |
成功与否(true/false) |
|
ResultCode |
String(5) |
R |
|
|
Reason |
String(50) |
O |
失败原因 |
返回示例:
|
{ "EBusinessID": "1237100", "Success": true, "ResultCode": "100", } |
提供源码下载：
https://download.csdn.net/download/yanghanwen/12139326
调用第三方物流接口，替换自己的key就能直接使用，主要实现了物流在线轨迹查询，订单订阅，轨迹推送，支持500多家的快递查询接口，包括主流的四通一达，支持上门取件服务，其他接口调用，修改调用指令和参数就能实现。 请求指令类型：1802
演示截图：
