Orders
Learn more about the orders resource
Last updated
Learn more about the orders resource
Last updated
Orders handle customers' purchases. When you create an order, you instruct Digital River, the authorized reseller, to send an authorization request to start the collection process.
The data of an order persist, acting as a permanent record of the sale, which Digital River is required to maintain for auditing purposes.
An order maintains an enduring record of when it was placed, a charge is created and captured, a refund is processed, and other key events in the order lifecycle occur. More specifically, an order persists:
A charge containing a payment source, an amount charged to that source, and the state of the charge
The following diagram depicts the relationship between an order and other resources in the Digital River APIs.
To ensure that your integration is functioning properly, you can create test orders using the information contained in the Testing Scenarios page.
In the following section, you'll find information on some of an order's attributes and how you might use them in downstream requests. For a complete list, refer to the Orders API reference documentation.
An order contains a unique id. You can use this identifier when initiating physical fulfillments, cancelling shipments, capturing and cancelling payments, creating physical returns, handling third-party returns, and issuing refunds.
An order's shipTo values are displayed on invoices and credit memos.
The total amount, fees, taxes, and other costs of the order are the same as those presented to customers when they confirm the purchase. You can retrieve these values and display them on the customer's order confirmation page.
Digital River assigns each of an order's items[] a unique id. You need this identifier when capturing and cancelling payments, handling third-party returns, and issuing refunds.
Depending on how you send product data in checkouts, each of an order's items[] also contains either a skuId or a productDetails object.
In addition, these items[] store detailed price, tax, and quantity information that you can display to customers on order confirmation and order detail pages.
For more information on subscriptionInfo, refer to the Subscription information page.
In most cases, Digital River populates an order's invoicePDFs and creditMemoPDFs with information that you can use to access and share tax invoices and credit memo files.
For more information about an order's state and fraudState, refer to the Order lifecycle page.
Orders with applied tax identifiers contain an array of tax identifier objects.
An order's charges[] contains one or more elements, each representing a charge created from a primary or secondary payment source. Each charge contains a unique identifier, an amount, a state, and the identifier of the payment source used to create the charge.
An order's requestToBeForgotten indicates whether an order's data is scheduled for deletion. This is the only attribute (other than metadata) that can be modified in an update order request.
Retrieves the details of an order. Supply the unique identifier of the order you would like to retrieve.
Order ID
OK.
The unique identifier for the order.
"ord_5823594809"The unique identifier of the checkout submitted to create the order.
"5823594809"Time at which the order was created.
"2018-04-25T20:36:00Z"The identifier of the customer associated with this order.
"cus_5774321009"A three-letter ISO currency code.
"usd"The customer's email address.
"jsmith@digitalriver.com"A designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.
"en_US"The IP address of the browser used by the customer when placing the order.
"111.111.111.111"An arbitrary string identifier that can be used to track the application type.
"68f72e0c-cb7d-48e1-93c8-998668ad0ff4"A list of the tax identifiers applied to this order.
The address from which a physical product is shipped.
Customer billing information.
Allows for the identification of a specific organization within a B2B transaction.
Represents the total order amount exclusive of tax.
1094.5Represents the total tax amount.
82.76Represents the total tax amount from the importer of record.
82.76If true, indicates that the tax amount is paid by the importer of record.
trueRepresents the total fee amount.
0Represents the total duty amount.
0Represents the total discount amount.
0Represents the total shipping amount.
5.76Represents the total charge amount.
1180.26The applied discount.
The available to refund amount at the order-level.
18.58Represents the total payment amount refunded.
Represents the total payment amount cancelled.
Represents the total payment amount captured.
An array of links to downloadable PDF invoices. If no invoices exist yet, the array is null.
An array of links to downloadable PDF credit memos. If no credit memos exist yet, the array is null.
If true indicates a user placing an order has requested this order be forgotten.
trueRepresents the shipping amount, description, taxes, and service level.
The current order state.
"created"Timestamps that indicate when the state transition occurred.
The fraud review state.
"passed"Timestamps that indicate when the state transition occurred.
Indicates the reason for the cancellation.
"fraud"Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Key-value pairs used to store additional data. Value can be string, boolean or integer types.
Represents the local selling entity.
Used to create a tax estimate for the customer.
The type of customer.
"individual"The upstream identifier.
"0916805858"Time at which the order was created.
"2018-04-25T20:37:00Z"