OrderReferenceDetails

Encapsulates details about an Order Reference object and its current state.

Datatype: content

Element Name Description
AmazonOrderReferenceId The order reference identifier retrieved from the Amazon Button widget.

Type: xs:string
BillingAddress Represents the billing address that is associated with the payment method selected by the buyer in the Wallet widget.

A complete billing address will be returned only if the following conditions are met:
  • You have passed the correct scope payments:billing_address
  • You specified a valid AccessToken in the GetOrderReferenceDetails operation.
Type: Address
Buyer Provides details about the buyer. This information will only be returned after you confirm the order reference.

Type: Buyer
OrderTotal Represents the total amount for this Order Reference object. This response element is not returned if you have not set it by calling the SetOrderReferenceDetails operation.

Type: OrderTotal
SellerNote Represents a description of the order that is shown in emails to the buyer. This response element is not returned if you have not set it by calling the SetOrderReferenceDetails operation.

Maximum: 1024 characters

Type: xs:string
PlatformId Represents the SellerId of the Solution Provider that developed the eCommerce platform. This response element is not returned if you have not set it by calling the SetOrderReferenceDetails operation.

Type: xs:string
Destination Represents the address selected by the buyer through the AddressBook widget.

Complete buyer information will only be returned after you have confirmed the order reference or have specified a valid AccessToken in the GetOrderReferenceDetails operation. Until then, only the City, StateOrRegion, PostalCode, and CountryCode elements are returned.

Type: Destination
ReleaseEnvironment Indicates if the order is for a Live (Production) or Sandbox environment.

Type: xs:string
SellerOrderAttributes Provides more context about the order represented by this order reference. This response element is not returned if you have not set it by calling the SetOrderReferenceDetails operation.

Type: SellerOrderAttributes
OrderReferenceStatus Indicates the current status of the order reference.

For more information about the State and ReasonCode response elements, see Order Reference States and Reason Codes.

Type: OrderReferenceStatus
OrderLanguage Represents the language last used on the Login or Consent screens by the buyer (whichever screen appeared last during checkout).

For more information about the OrderLanguage element, see Multi-language integration.

Type: xs:string
Constraints A list of constraints that indicates mandatory information that is missing or incorrect. The presence of constraints indicates that the order reference is not ready to be confirmed and cannot be used for payment operations.

For more information, see Order Reference Constraints.

Type: List of Constraint
CreationTimestamp The date and time, in UTC, when the order reference was created. In ISO 8601 format.

Type: xs:dateTime
ExpirationTimestamp The date and time, in UTC, when the order reference will expire and will no longer be valid for authorization requests. In ISO 8601 format.

Note: An order reference (if confirmed) expires 180 days after it is created. It will be canceled by Amazon if it is not confirmed within three hours of its creation.

Type: xs:dateTime
IdList A list of AmazonAuthorizationId identifiers that have been requested on this Order Reference object.

This list is empty if you have not requested any authorizations on this order reference.

Type: List of Type: xs:string