Orders
Last updated
Last updated
The Orders resource in the Digital River API facilitates the management of end-customer purchases. It provides comprehensive functionalities to create, retrieve, update, and list orders. This resource is essential for tracking sales, processing transactions, and managing inventory. By using the Orders API, businesses can streamline their order management workflow and enhance customer experience.
Get all orders.
/orders
A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
createdTime[gt]=2020-09-22T12:09:44ZA filter on the list based on the updatedTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
updatedTime[gt]=2020-09-22T12:09:44ZA cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.
A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.
A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.
Only return objects with these IDs.
Only return objects with these upstreamIds.
A filter on the list based on the totalAmount field. The value can be a string or it can be a dictionary with the following options: - eq-return values where the amount field equals to this amount - gt-return values where the amount field is greater than this amount - gte-return values where the amount field is greater than or equal to this amount - lt-return values where the amount field is less than this amount - lte-return values where the amount field is less than or equal to this amount
totalAmount[gt]=20.99Only return objects in the given state
Only return orders for the given customer
Only return orders for the given checkout
Only return orders for the given application
Only return orders with the given email
Only return orders in the given currency
Only return orders containing this sku
A filter on the list based on the order stateTransitions in_review field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
2018-03-25T20:36:00ZA filter on the list based on the order stateTransitions pending_payment field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
2018-03-25T20:36:00ZA filter on the list based on the order stateTransitions accepted field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
2018-03-25T20:36:00ZA filter on the list based on the order stateTransitions blocked field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
2018-03-25T20:36:00ZA filter on the list based on the order stateTransitions cancelled field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
2018-03-25T20:36:00ZA filter on the list based on the order stateTransitions fulfilled field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
2018-03-25T20:36:00ZA filter on the list based on the order stateTransitions complete field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
2018-03-25T20:36:00ZA filter on the list based on the order stateTransitions returned field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
2018-03-25T20:36:00ZOnly return orders in the given fraudState
A filter on the list based on the order fraudStateTransitions blocked field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
2018-03-25T20:36:00ZA filter on the list based on the order fraudStateTransitions review_opened field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
2018-03-25T20:36:00ZA filter on the list based on the order fraudStateTransitions passed field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
2018-03-25T20:36:00ZOnly return checkouts with this browser IP
Only return orders with this charge type
Only return orders with this subscription identifier
Only return orders with this refunded amount
Only return checkouts with this locale
Only return checkouts with this customer type
Creates a new order. For more details, refer to Converting a checkout to an order.
/orders
The unique identifier of a Checkout.
5823594809The identifier of the Customer associated with the Checkout.
5774321009The unique identifier of a Source.
src_a78cfeae-f7ae-4719-8e1c-d05ec04e4d37A three-letter ISO 4217 currency code.
USDThe customer's email address.
jsmith@digitalriver.comA designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.
en_IEThe unique identfier of the invoice attribute.
95f72e0c-cb7d-48e1-93c8-998668ad0ff4An arbitrary string identifier that can be used to track the application type.
68f72e0c-cb7d-48e1-93c8-998668ad0ff4The IP address of the browser used by the customer when placing the order.
111.111.111.111The 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 shipping amount, description, taxes, and service level.
The applied discount.
The applied discount.
If <code>true</code>, indicates that the prices supplied are tax inclusive.
trueRepresents the charge type.
merchant_initiatedcustomer_initiated, merchant_initiated, motoThe type of customer.
individualbusiness, individualKey-value pairs used to store additional data. Value can be string, boolean or integer types.
{"coupon":"iOS"}Used to create a tax estimate for the customer.
Any identifier that you want to associate with the resource. For tracking purposes, we recommend you provide the universally unique identifier (UUID) that identifies the corresponding order in your system. Unlike <code>metadata</code>, you can use this value as a query parameter in <code>GET</code> requests.
7765374748The assigned language.
enar, cs, da, de, el, en, en-us, en-gb, es, es-419, fi, fr, fr-ca, hu, it, ja, ko, nl, false, pl, pt, pt-br, ru, sk, sv, th, tr, zh, zh-hk, zh-tw[{"skuId":"5823594809","price":9.99,"discount":{"amountOff":10}},{"skuId":"5823594809","price":9.99,"quantity":2,"discount":{"amountOff":10}},{"skuId":"9234276173","price":9.99,"quantity":2}]Retrieves the details of an order. Supply the unique identifier of the order you would like to retrieve.
/orders/{id}
Order ID
Enhanced Payload
Updates an existing order.
/orders/{id}
Order ID
If <code>true</code>, indicates the user who placed the order has requested this order be forgotten.
trueThe upstream identifier.
0916805858Key-value pairs used to store additional data. Value can be string, boolean or integer types.
{"coupon":"iOS"}Refreshes an order so <code>payment.session.state</code>and/or <code>state</code> can be checked.
/orders/{id}/refresh
Order ID
Retrieves the tax details of each line item in an order. You're required to specify the order's identifier as a path parameter.
/orders/{id}/tax-details
Order ID