允许用户为已完成或已支付的订单申请退款,提交退款申请后等待管理员审核处理。
注意事项
- 该接口采用POST方法,需要以application/json格式提交数据
- 需要提供订单ID作为退款申请的标识
- 仅登录用户可以调用此接口
- 订单必须处于”已完成”或”已支付”状态才能申请退款
- 申请退款后订单状态将变为”退款中”
- 退款申请需要管理员审核处理
请求地址
{域名地址}/api/order/refund
说明:{域名地址} 需要替换成你的域名地址,如 https://www.anqicms.com/api/order/refund
请求语法
POST {域名地址}/api/order/refund
Content-Type: application/json
请求头
此接口需要用户登录认证,具体请参见公共请求头(Common Request Headers)。
请求参数
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| order_id | string | 是 | 订单ID |
响应头
此接口仅涉及公共响应头。更多信息,请参见公共请求头(Common Request Headers)。
返回参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| code | int | 错误码 |
| msg | string | 错误原因说明 |
使用示例
请求示例
POST /api/order/refund HTTP/1.1
Host: www.anqicms.com
Content-Type: application/json
{
"order_id": "202211232209080046"
}
响应示例
{
"code": 0,
"msg": "退款申请已提交"
}
错误代码
| 错误码 | 说明 |
|---|---|
| 0 | OK |
| -1 | 错误,错误原因在 msg 中指出 |
| 1001 | 未登录 |
| 1002 | 未授权 |
| 200 | API 请求 OK |
| 4001 | 订单不存在 |
| 4002 | 订单状态不允许申请退款 |
| 4003 | 订单已在退款处理中 |
| 4004 | 订单已过退款期限 |