印刷する

ストア

store > cancel_order

進行中の注文をキャンセルします。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

変数値説明
gostoreAPIセクション
docancel_orderAPIアクション
iqUser IDユーザーID

リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。

https://....../api.php?go=store&do=cancel_order&iq={user_id}&{required information}
POST変数

以下のPOST変数はオプションです。

変数値説明
requester (string) Requester 利用可能な値："ADMIN"（管理者またはアプリケーションが注文の取消を要求している場合）, "BUYER"（ユーザーが注文の取消を要求している場合）

応答例

リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・ok

{
    "ok": "The order was cancelled"
}

リクエストにハッシュが指定されていない場合など、リクエストが失敗した場合のレスポンス

{
    "error"      : "REQUEST_ERROR",
    "error_long" : "Missing signature"
}

このリクエストは以下のエラーを返す可能性があります。

・REQUEST_ERROR | Invalid User ID
ユーザーIDが指定されていないか無効、もしくは1未満です。

・ERROR_NO_ORDER | There is no order to cancel
進行中の注文がありません。

・ERROR | Error cancelling the order
注文のキャンセルにエラーがありました。

その他のエラー内容に関しては一般的なエラーメッセージを確認してください。

PHPサンプルコード

GETおよびPOSTデータを準備します。

// GET変数
$GET_VARS = array( 
					"go"        => "store",
					"do"        => "cancel_order",
					"iq"        => "2"
					);

// POST変数
$POST_VARS = array( 
					"requester"    => "ADMIN"
					);