跳转到主要内容
取消待处理(未支付)的一次性订单。只有尚未支付的订单可以取消。
POST /v1/actions/onetime-order/cancel-order
认证方式: API Key

请求体

字段类型必需说明
orderIdstring订单 ID(Short ID 格式 ORD_xxx

请求示例

import { WaffoPancake } from "@waffo/pancake-ts";

const client = new WaffoPancake({
  merchantId: process.env.WAFFO_MERCHANT_ID!,
  privateKey: process.env.WAFFO_PRIVATE_KEY!,
});

const result = await client.orders.cancelOnetimeOrder({
  orderId: "ORD_3K5L8M2N4P6Q9R7J",
});

console.log(result.orderId); // "ORD_3K5L8M2N4P6Q9R7J"
console.log(result.status);  // "canceled"

成功响应

{
  "data": {
    "orderId": "ORD_3K5L8M2N4P6Q9R7J",
    "status": "canceled"
  }
}

响应字段

字段类型说明
orderIdstringShort ID 格式的订单 ID
statusstring新的订单状态(canceled

错误

状态码消息说明
400订单非待处理状态只有 pending 状态的订单可以取消
404订单未找到没有匹配给定 orderId 的订单
只有 pending 状态(支付尚未完成)的订单可以取消。对于已完成的订单,请使用退款端点