注文のキャンセル

注文が完了して支払いが行われる前に、eSuiteプラットフォームは注文をキャンセルし、支払いの実行とアクセスの許可を防止します。

概要

APIメソッドとしてのCancelOrderは、顧客がeSuiteプラットフォーム内で注文を取り消したい場合にご利用される為のものです。キャンセルは、完了していない注文に対してのみ行うことができます、支払いはまだ取られていません。支払いが行われた場合、RefundOrderを呼び出す必要があります。

リクエスト

[csharp] using (var client = new eDeveloperClient())
{
var request = new CancelOrderRequest
{
clientId = 433;
apiPassword = "sN?67oS=cE";
orderId = 5461385;
reason = "A messsage";
sendEmail = true;
};

var result = client.CancelOrder(request);
}
[/csharp]

リクエストパラメータ

次の表は、CancelOrderに提供する必要がある引数の一覧です。また、必須の引数も識別します。

名称	データタイプ	説明	必須か？	値の例
ClientId	Integer	MPPによって支払いサービスが実装されている各Webサイトに割り当てられます。これは、MPPアカウントマネージャーによって提供され、各マーチャントへ固有のものです。	Yes	433
ApiPassword	String	割り当てられたWebサービスのパスワード。	Yes	sN?67oS=cE
OrderId	整数	The unique reference for the Order you'd like to cancel.	Yes	547653
Reason	文字列	An optional message you can log for the completion.	No	"A Message"
SendEmail	Boolean	キャンセルを通知する電子メールをユーザーに送信します。	No	True
CancellationType	String	標準のキャンセルタイプが渡された場合、注文にはキャンセル済のステータスが与えられます。未払いのキャンセルタイプが渡された場合、その注文には未支払のステータスが与えられます。	No	Unpaid

注文のキャンセル

概要

リクエスト

リクエストパラメータ

See Also