CancelOrderReference | Amazon Pay Japan

CancelOrderReference

以前に承認されたOrder Referenceをキャンセルします。

説明

以前に承認されたOrder ReferenceをキャンセルするためにCancelOrderReference処理を呼び出します。 CompletedClosedPending 状態の売上請求が存在する場合は、Order Referenceオブジェクトをキャンセルできません。Order Referenceをキャンセルする場合は、このOrder Referenceに関連する全てのオーソリはClosed にされます。

この処理を呼び出した後で、Order ReferenceはCanceled状態に遷移します。

本番環境では、この処理の最大リクエストクォーターは10であり、回復レートは1秒間に1回です。SANDBOX環境では、最大リクエストクォーターは2であり、回復レートは2秒間に1回です。

リクエストパラメータ

パラメータ名 必須 タイプ 説明
AmazonOrderReferenceId 必須 td width="14%" xs:string Order ReferenceのIDです。

この値は購入者がAmazonによって認証に成功した後にAmazonボタンウィジェットから取得されます。
CancelationReason オプション xs:string キャンセルした理由を記述します。これは内部処理でのみ利用し、顧客には表示されません。この値は、GetOrderReferenceDetails呼び出しで取得できます。

最大:1024文字

レスポンス要素

この処理は、標準レスポンス要素のみ返します。

サンプル

呼び出しリクエストのサンプル

 
POST /OffAmazonPayments/2013-01-01 HTTP/1.1  
Content-Type: x-www-form-urlencoded  
Host: mws.amazonservices.com  
User-Agent: <Your User Agent Header>  
AWSAccessKeyId=AKIAJKYFSJU7PEXAMPLE  
&Action=CancelOrderReference  
&AmazonOrderReferenceId=P01-1234567-1234567  
&SellerId=YOUR_SELLER_ID_HERE  
&SignatureMethod=HmacSHA256  
&SignatureVersion=2  
&Timestamp=2012-12-19T19%3A01%3A11Z  
&Version=2013-01-01  
&Signature=CLZOdtJGjAo81IxaLoE7af6HqK0EXAMPLE

レスポンスのサンプル''

 
<CancelOrderReferenceResponse  
xmlns="https://mws.amazonservices.com/schema/OffAmazonPayments/2013-01-01">  
  <ResponseMetadata>  
    <RequestId>5f20169b-7ab2-11df-bcef-d35615e2b044</RequestId>  
  </ResponseMetadata>  
</CancelOrderReferenceResponse>