取消用户指定的订单,将订单状态更新为已取消。
注意事项
- 该接口采用POST方法,需要以application/json格式提交数据
- 需要用户登录后才能访问
- 只能取消属于当前用户的订单
- 订单必须处于可取消状态才能被取消
请求地址
{域名地址}/api/order/cancel
说明:{域名地址} 需要替换成你的域名地址,如 https://www.anqicms.com/api/order/cancel
请求语法
POST {域名地址}/api/order/cancel
Content-Type: application/json
请求头
此接口还涉及公共请求头。更多信息,请参见公共请求头(Common Request Headers)。
请求参数
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| order_id | string | 是 | 订单ID |
响应头
此接口仅涉及公共响应头。更多信息,请参见公共请求头(Common Request Headers)。
返回参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| code | int | 错误码 |
| msg | string | 错误原因说明 |
使用示例
请求示例
POST /api/order/cancel 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 |