CloseOrderReference

Confirms that an order reference has been fulfilled (fully or partially) and that you do not expect to create any new authorizations on this order reference.

Description

To indicate that a previously confirmed order reference has been fulfilled (fully or partially) and that you do not expect to create any new authorizations on this order reference, call the CloseOrderReference operation. You can still capture funds against open authorizations on the order reference.

After you call this operation, the order reference is moved into the Closed state.

This operation has a maximum request quota of 10 and a restore rate of one request every second in the production environment. It has a maximum request quota of two and a restore rate of one request every two seconds in the sandbox environment. For definitions of throttling terminology and for a complete explanation of throttling, see Throttling: Limits to how often you can submit requests in the Amazon MWS Developer Guide.

Request parameters

For more information about the request parameters that are required for all Amazon MWS operations, see Required request parameters in the Amazon MWS Developer Guide.

Parameter name Required Type Description
AmazonOrderReferenceId Yes xs:string The ID of the order reference for which the details are being requested.

This value is retrieved from the Amazon Button widget after the buyer has successfully authenticated with Amazon.
ClosureReason No xs:string Describes the reason for closing the order reference. This is for informational purposes only and is never shown to the customer. The value can be retrieved in future GetOrderReferenceDetails calls.

Maximum: 1024 characters

Response elements

This operation returns only the standard response elements.

Examples

Sample query request


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=CloseOrderReference
&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

Sample response


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

See also