CancelOrderReference

Cancels a previously confirmed order reference.

Description

To cancel a previously confirmed order reference, call the CancelOrderReference operation. You can cancel an Order Reference object only if there are no Completed, Closed, or Pending captures against it. If you cancel an order reference, all authorizations associated with this order reference are also closed.

After you call this operation, the order reference is moved into the Canceled 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

Description

AmazonOrderReferenceId

Required
xs:string

The order reference identifier.

This value is retrieved from the Amazon Button widget after the buyer has successfully authenticated with Amazon.

CancelationReason

Optional
xs:string

Describes the reason for the cancellation. 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=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

Sample response

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

See also


Copyright © 2009-2018 Amazon.com, Inc. or its affiliates. Amazon and Amazon.com are registered trademarks of Amazon.com, Inc. or its affiliates. All other trademarks are the property of their respective owners.