SetOrderReferenceDetails | Amazon Pay

SetOrderReferenceDetails

Sets order reference details such as the order total and a description for the order.

Description

Call the SetOrderReferenceDetails operation to specify order details such as the amount of the order, a description of the order, and other order attributes.

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 This value is retrieved from the Amazon Button widget after the buyer has successfully authenticated with Amazon.
OrderReferenceAttributes Yes OrderReferenceAttributes The merchant-specified attributes of the order reference.

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=0GS7553JW74RRM612K02EXAMPLE
&Action=SetOrderReferenceDetails
&AmazonOrderReferenceId=P01-1234567-1234567
&OrderReferenceAttributes.OrderTotal.Amount=106
&OrderReferenceAttributes.OrderTotal.CurrencyCode=USD
&OrderReferenceAttributes.PlatformId=PLATFORM_ID_HERE
&OrderReferenceAttributes.SellerNote=Lorem%20ipsum
&OrderReferenceAttributes.SellerOrderAttributes.SellerOrderId=5678-23
&OrderReferenceAttributes.SellerOrderAttributes.StoreName=YOUR_STORE_NAME 
&SellerId=YOUR_SELLER_ID
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Timestamp=2012-11-05T19%3A01%3A11Z
&Version=2013-01-01
&Signature=2RPzkOgQmDybUjk0dA54maCEXAMPLE
    

Note the following requirements:

  • The &Action must precede the &AmazonOrderReferenceId.
  • The &SignatureMethod value of HmacSHA256 is case sensitive.

Example Response


<SetOrderReferenceDetailsResponse
  xmlns="https://mws.amazonservices.com/
        schema/OffAmazonPayments/2013-01-01">
<SetOrderReferenceDetailsResult>
  <OrderReferenceDetails>
    <AmazonOrderReferenceId>P01-1234567-1234567</AmazonOrderReferenceId>
    <OrderTotal>
      <Amount>106</Amount>
      <CurrencyCode>USD</CurrencyCode>
    </OrderTotal>
    <SellerOrderAttributes>
      <SellerOrderId>5678-23</SellerOrderId>
    </SellerOrderAttributes>
    <SellerNote>Lorem ipsum</SellerNote>
    <CreationTimestamp>2012-11-05T20:21:19Z</CreationTimestamp>
    <ExpirationTimestamp>2013-05-07T23:21:19Z</ExpirationTimestamp>
    <OrderReferenceStatus>
      <State>Draft</State>
    </OrderReferenceStatus>
    <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>
</SetOrderReferenceDetailsResult>
<ResponseMetadata>
  <RequestId>f42df4b1-8047-11df-8d5c-bf56a38ef3b4</RequestId>
</ResponseMetadata>
</SetOrderReferenceDetailsResponse>