GetOrderReferenceDetails

Returns details about the Order Reference object and its current state.

Description

The GetOrderReferenceDetails operation returns details about the Order Reference object and its current state. An Order Reference object provides the following details about an order:

  • Buyer
  • Amount
  • Description
  • Destination (optional)
  • Merchant order attributes (optional)
  • List of constraints (optional)
  • Billing address (optional)

This operation has a maximum request quota of 20 and a restore rate of two requests every second in the production environment. It has a maximum request quota of five and a restore rate of one request every second 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 order reference identifier.

This value is retrieved from the Amazon Button widget after the buyer has successfully authenticated with Amazon.
AccessToken No xs:string Login with Amazon Access Token.

Available after the buyer is successfully authenticated using Login with Amazon.

Required to retrieve the full shipping address and/or billing address before order confirmation.

The additional scope parameters, payments:shipping_address and/or payments:billing_address, must be set.

Response Elements

Element Name Description
OrderReferenceDetails Encapsulates details about the Order Reference object and its current state.

Type: OrderReferenceDetails

Examples

Example 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=GetOrderReferenceDetails
&AccessToken=YOUR_ACCESS_TOKEN
&AmazonOrderReferenceId=P01-1234567-1234567
&SellerId=YOUR_SELLER_ID_HERE
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Timestamp=2012-11-05T19%3A01%3A11Z
&Version=2013-01-01
&Signature=CLZOdtJGjAo81IxaLoE7af6HqK0EXAMPLE
    

Example Response


<GetOrderReferenceDetailsResponse
  xmlns="http://mws.amazonservices.com/
        schema/OffAmazonPayments/2013-01-01">
<GetOrderReferenceDetailsResult>
  <OrderReferenceDetails>
    <AmazonOrderReferenceId>P01-1234567-1234567</AmazonOrderReferenceId>
    <CreationTimestamp>2012-11-05T20:21:19Z</CreationTimestamp>
    <ExpirationTimestamp>2013-05-07T23:21:19Z</ExpirationTimestamp>
    <OrderReferenceStatus>
      <State>Draft</State>
    </OrderReferenceStatus>
    <OrderLanguage>de-DE</OrderLanguage>
    <Destination>
      <DestinationType>Physical</DestinationType>
      <PhysicalDestination>
        <City>New York</City>
        <StateOrRegion>NY</StateOrRegion>
        <PostalCode>10101-9876</PostalCode>
        <CountryCode>US</CountryCode>
      </PhysicalDestination>
    </Destination>
    <ReleaseEnvironment>Live</ReleaseEnvironment>
  </OrderReferenceDetails>
</GetOrderReferenceDetailsResult>
<ResponseMetadata>
  <RequestId>5f20169b-7ab2-11df-bcef-d35615e2b044</RequestId>
</ResponseMetadata>
</GetOrderReferenceDetailsResponse>