POST/api/v1/orders/:orderId/cancel取消订单

Try it 面板需要启用 JavaScript。

取消待支付订单；已支付订单走管理端退款。

Request

Headers

Name	Data Type	Required	Description
Authorization	string	Yes	会话令牌认证，格式 `Bearer <sessionToken>`

type RequestHeaders = {
  /** 会话令牌认证，格式 `Bearer <sessionToken>` */
  Authorization: string
}

URL Parameters

Name	Data Type	Description
orderId	string	订单 ID

Response

Body

Name	Data Type	Required	Description
orderId	string	Yes	订单 ID
status	string	Yes	固定为 canceled
canceledAt	string	Yes	取消时间

type ResponseBody = {
  /** 订单 ID */
  orderId: string
  /** 固定为 canceled */
  status: string
  /** 取消时间 */
  canceledAt: string
}

{
  "orderId": "01JD8SNZFT8A1B7HB",
  "status": "canceled",
  "canceledAt": "2026-10-14T15:10:00Z"
}

HTTP Code

HTTP Status	Meaning	Notes
200	成功	订单已取消
409	状态不允许	订单已支付或已取消

Response Code

响应使用统一信封 {id, code, messages, result}，其 code 字段：

code	Meaning	Notes
0	成功	订单已取消
2803	订单状态不允许取消	订单已支付 / 已取消 / 已退款

Examples

POST /api/v1/orders/01JD8SNZFT8A1B7HB/cancel
Authorization: Bearer st_7c1f9e05b28d4a63

{
  "id": "01JD8SSTJO8J6LE",
  "code": 0,
  "messages": [],
  "result": {
    "orderId": "01JD8SNZFT8A1B7HB",
    "status": "canceled",
    "canceledAt": "2026-10-14T15:10:00Z"
  }
}