メインコンテンツへスキップ
保留中（未払い）の単発注文をキャンセルします。まだ支払いが完了していない注文のみキャンセルできます。 
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"
  }
}

​
レスポンスフィールド

フィールド型説明
orderIdstring注文 ID（Short ID 形式）
statusstring新しい注文ステータス（canceled）

​
エラー

ステータスメッセージ説明
400Order is not pendingpending ステータスの注文のみキャンセルできます
404注文が見つかりません指定された orderId に一致する注文がありません
pending ステータス（支払い未完了）の注文のみキャンセルできます。完了済みの注文には、代わりに返金エンドポイントを使用してください。