微信小程序 运力方使用·onCancelOrder
logistics.onCancelOrder
本文档描述服务器端接收的消息或事件，详细说明参见消息推送。
取消订单事件。
消息参数
Object
| 属性 | 类型 | 说明 |
|---|---|---|
| ToUserName | string | 快递公司小程序 UserName |
| FromUserName | string | 下单用户的 OpenID |
| CreateTime | number | 事件时间，Unix 时间戳 |
| MsgType | string | 消息类型，固定为 event |
| Event | string | 事件类型，固定为 cancel_waybill |
| OrderID | string | 唯一标识订单的 ID，由商户生成 |
| BizID | string | 商户 ID |
| BizPwd | string | 商户密码 |
| ShopAppID | string | 商户的小程序 AppID |
| WayBillID | string | 运单 ID，从微信号段中生成 |
消息返回
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| ToUserName | string | 是 | 原样返回请求中的 FromUserName | |
| FromUserName | string | 是 | 快递公司小程序 UserName | |
| CreateTime | number | 是 | 事件时间，Unix 时间戳 | |
| MsgType | string | 是 | 消息类型，固定为 event | |
| Event | string | 是 | 事件类型，固定为 cancel_waybill，不区分大小写 | |
| BizID | string | 是 | 商户ID，请原样返回 | |
| OrderID | string | 是 | 唯一标识订单的ID，由商户生成。请原样返回 | |
| WayBillID | string | 是 | 运单ID，请原样返回 | |
| ResultCode | number | 是 | 处理结果错误码 | |
| ResultMsg | string | 是 | 处理结果详情 |
ResultCode 的合法值
| 值 | 说明 | 最低版本 |
|---|---|---|
| 0 | 取消成功 | |
| -1 | 其他错误 | |
| 30001 | 参数错误（BizID、OrderID、WayBillID不存在） | |
| 30002 | 已经揽收，不可取消 | |
| 30003 | 无效单（如已经取消过、或签收超过一定时间），不可取消 | |
| 30004 | 快递不支持取消运单 |
消息数据包示例
XML 格式
<xml>
<ToUserName><![CDATA[gh_abcdefg]]></ToUserName>
<FromUserName><![CDATA[oABCD]]></FromUserName>
<CreateTime>1533042556</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[cancel_waybill]]></Event>
<BizID><![CDATA[xyz]]></BizID>
<BizPwd><![CDATA[xyz123]]></BizPwd>
<ShopAppID><![CDATA[wxABCD]]></ShopAppID>
<OrderID><![CDATA[012345678901234567890123456789]]></OrderID>
<WayBillID><![CDATA[123456789]]></WayBillID>
</xml>
JSON 格式
{
"ToUserName": "gh_abcdefg",
"FromUserName": "oABCD",
"CreateTime": 1533042556,
"MsgType": "event",
"Event": "cancel_waybill",
"BizID": "xyz",
"BizPwd": "xyz123",
"ShopAppID": "wxABCD",
"OrderID": "012345678901234567890123456789",
"WayBillID": "123456789"
}
返回数据包示例
XML 格式
<xml>
<ToUserName><![CDATA[oABCD]]></ToUserName>
<FromUserName><![CDATA[gh_abcdefg]]></FromUserName>
<CreateTime>1533042556</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[cancel_waybill]]></Event>
<BizID><![CDATA[xyz]]></BizID>
<OrderID><![CDATA[012345678901234567890123456789]]></OrderID>
<WayBillID><![CDATA[123456789]]></WayBillID>
<ResultCode>0</ResultCode>
<ResultMsg><![CDATA[success]]></ResultMsg>
</xml>
JSON 格式
{
"ToUserName": "oABCD",
"FromUserName": "gh_abcdefg",
"CreateTime": 1533042556,
"MsgType": "event",
"Event": "cancel_waybill",
"BizID": "xyz",
"OrderID": "012345678901234567890123456789",
"WayBillID": "123456789",
"ResultCode": 0,
"ResultMsg": "success"
}