微信小程序 运力方使用·onCancelOrder

2020-07-31 14:04 更新

logistics.onCancelOrder

本文档描述服务器端接收的消息或事件,详细说明参见消息推送

取消订单事件。

消息参数

Object

属性类型说明
ToUserNamestring快递公司小程序 UserName
FromUserNamestring下单用户的 OpenID
CreateTimenumber事件时间,Unix 时间戳
MsgTypestring消息类型,固定为 event
Eventstring事件类型,固定为 cancel_waybill
OrderIDstring唯一标识订单的 ID,由商户生成
BizIDstring商户 ID
BizPwdstring商户密码
ShopAppIDstring商户的小程序 AppID
WayBillIDstring运单 ID,从微信号段中生成

消息返回

属性类型默认值必填说明
ToUserNamestring原样返回请求中的 FromUserName
FromUserNamestring快递公司小程序 UserName
CreateTimenumber事件时间,Unix 时间戳
MsgTypestring消息类型,固定为 event
Eventstring事件类型,固定为 cancel_waybill,不区分大小写
BizIDstring商户ID,请原样返回
OrderIDstring唯一标识订单的ID,由商户生成。请原样返回
WayBillIDstring运单ID,请原样返回
ResultCodenumber处理结果错误码
ResultMsgstring处理结果详情

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"
}


以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号