订单取消API

对接规范

接口编码:/api/OrderCancel.shtml

接口名称:OrderCancel

1.1. 功能描述

由客户方向平台发送订单取消请求,平台接收到请求后返回信息。只能取消通过接口或者在VIP后台支付产生的待审核订单,取消成功后订单状态变为待提交

1.2.接口参数

1.2.1. 输入参数

序号 名称 类型 示例 是否必须 是否重复 更多限制 描述
1 OrderNo String wz20190101001 必须 不可重复 有拆单则为子订单号 订单号
2 Reason String 测试订单取消 必须 不可重复 最大255字符 取消原因

1.2.2. 输出参数

序号 名称 类型 示例 描述
1 success Boolean true 请求是否成功
2 validate Boolean true 是否成功(以success为准)
3 result Object 结果
4 message String 成功 成功或失败信息
result
序号 名称 类型 示例 描述
1 OrderNo String wz20190101001 (子)订单号
2 Amount Number 52.50 退款金额

1.2.3. JSON示例

RequestJSON:

{ "OrderNo": "wz20190101001", "Reason": "测试订单" }

ResponseJSON:

{ "OrderNo": "wz20190101001", "Amount": 52.50 }

API测试工具

测试接口