search
System Status

Orders

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.

hashtag
Returns a list of orders

get

Get all orders.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
endingBeforestringOptional

A 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.

startingAfterstringOptional

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.

limitinteger · min: 1 · max: 100Optional

A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.

idsstring[]Optional

Only return objects with these IDs.

upstreamIdsstring[]Optional

Only return objects with these upstreamIds.

statestringOptional

Only return objects in the given state

customerIdstringOptional

Only return orders for the given customer

checkoutIdstringOptional

Only return orders for the given checkout

applicationIdstringOptional

Only return orders for the given application

emailstringOptional

Only return orders with the given email

currencystringOptional

Only return orders in the given currency

skuIdstringOptional

Only return orders containing this sku

fraudStatestringOptional

Only return orders in the given fraudState

browserIpstringOptional

Only return checkouts with this browser IP

chargeTypestringOptional

Only return orders with this charge type

subscriptionIdstringOptional

Only return orders with this subscription identifier

refundedAmountstringOptional

Only return orders with this refunded amount

localestringOptional

Only return checkouts with this locale

customerTypestringOptional

Only return checkouts with this customer type

Responses
chevron-right
200

200 OK

application/json
hasMorebooleanOptional

Whether or not there are more elements available after this set. If false this set represents the end of the list.

Example: true
get
/orders

hashtag
Creates a new order

post

Creates a new order. For more details, refer to Converting a checkout to an order.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
checkoutIdstringOptional

The unique identifier of a Checkout.

Example: 5823594809
customerIdstringOptional

The identifier of the Customer associated with the Checkout.

Example: 5774321009
sourceIdstringOptional

The unique identifier of a Source.

Example: src_a78cfeae-f7ae-4719-8e1c-d05ec04e4d37
currencystringOptional

A three-letter ISO 4217 currency code.

Example: USD
emailstring · emailOptional

The customer's email address.

Example: [email protected]
languagestring · enumOptional

The assigned language.

Example: enPossible values:
localestringOptional

A designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.

Example: en_IE
invoiceAttributeIdstringOptional

The unique identfier of the invoice attribute.

Example: 95f72e0c-cb7d-48e1-93c8-998668ad0ff4
applicationIdstringOptional

An arbitrary string identifier that can be used to track the application type.

Example: 68f72e0c-cb7d-48e1-93c8-998668ad0ff4
browserIpstringOptional

The IP address of the browser used by the customer when placing the order.

Example: 111.111.111.111
taxInclusivebooleanOptional

If true, indicates that the prices supplied are tax inclusive.

Example: true
chargeTypestring · enumOptional

Represents the charge type.

Example: merchant_initiatedPossible values:
customerTypestring · enumOptional

The type of customer.

Example: individualPossible values:
upstreamIdstringOptional

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 metadata, you can use this value as a query parameter in GET requests.

Example: 7765374748
Responses
post
/orders

hashtag
Gets an order by ID

get

Retrieves the details of an order. Supply the unique identifier of the order you would like to retrieve.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Order ID

Query parameters
expandbooleanOptional

Enhanced Payload

Responses
chevron-right
200

OK.

application/json
idstringRead-onlyOptional

The unique identifier for the order.

Example: ord_5823594809
checkoutIdstringOptional

The unique identifier of the checkout submitted to create the order.

Example: 5823594809
createdTimestring · date-timeRead-onlyOptional

Time at which the order was created.

Example: 2018-04-25T20:36:00Z
customerIdstringOptional

The identifier of the customer associated with this order.

Example: cus_5774321009
currencystringOptional

A three-letter ISO currency code.

Example: usd
emailstring · emailOptional

The customer's email address.

Example: [email protected]
languagestring · enumOptional

The assigned language.

Example: enPossible values:
localestringOptional

A designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.

Example: en_IE
browserIpstringOptional

The IP address of the browser used by the customer when placing the order.

Example: 111.111.111.111
applicationIdstringRead-onlyOptional

An arbitrary string identifier that can be used to track the application type.

Example: 68f72e0c-cb7d-48e1-93c8-998668ad0ff4
subtotalnumber · doubleRead-onlyOptional

Represents the total order amount exclusive of tax.

Example: 1094.5
totalTaxnumber · doubleRead-onlyOptional

Represents the total tax amount.

Example: 82.76
totalImporterTaxnumber · doubleOptional

Represents the total tax amount from the importer of record.

Example: 82.76
importerOfRecordTaxboolean · nullableRead-onlyOptional

If true, indicates that the tax amount is paid by the importer of record.

Example: true
totalFeesnumber · doubleRead-onlyOptional

Represents the total fee amount.

Example: 0
totalDutynumber · doubleRead-onlyOptional

Represents the total duty amount.

Example: 0
totalDiscountnumber · doubleRead-onlyOptional

Represents the total discount amount.

Example: 0
totalShippingnumber · doubleRead-onlyOptional

Represents the total shipping amount.

Example: 5.76
totalAmountnumber · doubleRead-onlyOptional

Represents the total charge amount.

Example: 1180.26
availableToRefundAmountnumber · double · nullableOptional

The available to refund amount at the order-level.

Example: 18.58
refundedAmountnumber · doubleRead-onlyOptional

Represents the total payment amount refunded.

cancelledAmountnumber · doubleRead-onlyOptional

Represents the total payment amount cancelled.

capturedAmountnumber · doubleRead-onlyOptional

Represents the total payment amount captured.

requestToBeForgottenbooleanOptional

If true indicates a user placing an order has requested this order be forgotten.

Default: falseExample: true
statestring · enumRead-onlyOptional

The current order state.

Example: createdPossible values:
fraudStatestring · enumRead-onlyOptional

The fraud review state.

Example: passedPossible values:
cancelReasonstring · max: 64Optional

Indicates the reason for the cancellation.

Example: fraud
liveModebooleanOptional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

customerTypestring · enumOptional

The type of customer.

Example: individualPossible values:
chargeTypestring · enumOptional

Represents the charge type.

Example: merchant_initiatedPossible values:
upstreamIdstring · nullableOptional

The upstream identifier.

Example: 0916805858
updatedTimestring · date-timeRead-onlyOptional

Time at which the order was created.

Example: 2018-04-25T20:37:00Z
get
/orders/{id}

hashtag
Updates an existing order

post

Updates an existing order.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Order ID

Body
requestToBeForgottenbooleanOptional

If true, indicates the user who placed the order has requested this order be forgotten.

Default: falseExample: true
upstreamIdstring · nullableOptional

The upstream identifier.

Example: 0916805858
Responses
chevron-right
200

200 OK

application/json
idstringRead-onlyOptional

The unique identifier for the order.

Example: ord_5823594809
checkoutIdstringOptional

The unique identifier of the checkout submitted to create the order.

Example: 5823594809
createdTimestring · date-timeRead-onlyOptional

Time at which the order was created.

Example: 2018-04-25T20:36:00Z
customerIdstringOptional

The identifier of the customer associated with this order.

Example: cus_5774321009
currencystringOptional

A three-letter ISO currency code.

Example: usd
emailstring · emailOptional

The customer's email address.

Example: [email protected]
languagestring · enumOptional

The assigned language.

Example: enPossible values:
localestringOptional

A designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.

Example: en_IE
browserIpstringOptional

The IP address of the browser used by the customer when placing the order.

Example: 111.111.111.111
applicationIdstringRead-onlyOptional

An arbitrary string identifier that can be used to track the application type.

Example: 68f72e0c-cb7d-48e1-93c8-998668ad0ff4
subtotalnumber · doubleRead-onlyOptional

Represents the total order amount exclusive of tax.

Example: 1094.5
totalTaxnumber · doubleRead-onlyOptional

Represents the total tax amount.

Example: 82.76
totalImporterTaxnumber · doubleOptional

Represents the total tax amount from the importer of record.

Example: 82.76
importerOfRecordTaxboolean · nullableRead-onlyOptional

If true, indicates that the tax amount is paid by the importer of record.

Example: true
totalFeesnumber · doubleRead-onlyOptional

Represents the total fee amount.

Example: 0
totalDutynumber · doubleRead-onlyOptional

Represents the total duty amount.

Example: 0
totalDiscountnumber · doubleRead-onlyOptional

Represents the total discount amount.

Example: 0
totalShippingnumber · doubleRead-onlyOptional

Represents the total shipping amount.

Example: 5.76
totalAmountnumber · doubleRead-onlyOptional

Represents the total charge amount.

Example: 1180.26
availableToRefundAmountnumber · double · nullableOptional

The available to refund amount at the order-level.

Example: 18.58
refundedAmountnumber · doubleRead-onlyOptional

Represents the total payment amount refunded.

cancelledAmountnumber · doubleRead-onlyOptional

Represents the total payment amount cancelled.

capturedAmountnumber · doubleRead-onlyOptional

Represents the total payment amount captured.

requestToBeForgottenbooleanOptional

If true indicates a user placing an order has requested this order be forgotten.

Default: falseExample: true
statestring · enumRead-onlyOptional

The current order state.

Example: createdPossible values:
fraudStatestring · enumRead-onlyOptional

The fraud review state.

Example: passedPossible values:
cancelReasonstring · max: 64Optional

Indicates the reason for the cancellation.

Example: fraud
liveModebooleanOptional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

customerTypestring · enumOptional

The type of customer.

Example: individualPossible values:
chargeTypestring · enumOptional

Represents the charge type.

Example: merchant_initiatedPossible values:
upstreamIdstring · nullableOptional

The upstream identifier.

Example: 0916805858
updatedTimestring · date-timeRead-onlyOptional

Time at which the order was created.

Example: 2018-04-25T20:37:00Z
post
/orders/{id}

hashtag
Refreshes an existing order

post

Refreshes an order so payment.session.stateand/or state can be checked.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Order ID

Responses
chevron-right
200

OK.

application/json
idstringRead-onlyOptional

The unique identifier for the order.

Example: ord_5823594809
checkoutIdstringOptional

The unique identifier of the checkout submitted to create the order.

Example: 5823594809
createdTimestring · date-timeRead-onlyOptional

Time at which the order was created.

Example: 2018-04-25T20:36:00Z
customerIdstringOptional

The identifier of the customer associated with this order.

Example: cus_5774321009
currencystringOptional

A three-letter ISO currency code.

Example: usd
emailstring · emailOptional

The customer's email address.

Example: [email protected]
languagestring · enumOptional

The assigned language.

Example: enPossible values:
localestringOptional

A designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.

Example: en_IE
browserIpstringOptional

The IP address of the browser used by the customer when placing the order.

Example: 111.111.111.111
applicationIdstringRead-onlyOptional

An arbitrary string identifier that can be used to track the application type.

Example: 68f72e0c-cb7d-48e1-93c8-998668ad0ff4
subtotalnumber · doubleRead-onlyOptional

Represents the total order amount exclusive of tax.

Example: 1094.5
totalTaxnumber · doubleRead-onlyOptional

Represents the total tax amount.

Example: 82.76
totalImporterTaxnumber · doubleOptional

Represents the total tax amount from the importer of record.

Example: 82.76
importerOfRecordTaxboolean · nullableRead-onlyOptional

If true, indicates that the tax amount is paid by the importer of record.

Example: true
totalFeesnumber · doubleRead-onlyOptional

Represents the total fee amount.

Example: 0
totalDutynumber · doubleRead-onlyOptional

Represents the total duty amount.

Example: 0
totalDiscountnumber · doubleRead-onlyOptional

Represents the total discount amount.

Example: 0
totalShippingnumber · doubleRead-onlyOptional

Represents the total shipping amount.

Example: 5.76
totalAmountnumber · doubleRead-onlyOptional

Represents the total charge amount.

Example: 1180.26
availableToRefundAmountnumber · double · nullableOptional

The available to refund amount at the order-level.

Example: 18.58
refundedAmountnumber · doubleRead-onlyOptional

Represents the total payment amount refunded.

cancelledAmountnumber · doubleRead-onlyOptional

Represents the total payment amount cancelled.

capturedAmountnumber · doubleRead-onlyOptional

Represents the total payment amount captured.

requestToBeForgottenbooleanOptional

If true indicates a user placing an order has requested this order be forgotten.

Default: falseExample: true
statestring · enumRead-onlyOptional

The current order state.

Example: createdPossible values:
fraudStatestring · enumRead-onlyOptional

The fraud review state.

Example: passedPossible values:
cancelReasonstring · max: 64Optional

Indicates the reason for the cancellation.

Example: fraud
liveModebooleanOptional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

customerTypestring · enumOptional

The type of customer.

Example: individualPossible values:
chargeTypestring · enumOptional

Represents the charge type.

Example: merchant_initiatedPossible values:
upstreamIdstring · nullableOptional

The upstream identifier.

Example: 0916805858
updatedTimestring · date-timeRead-onlyOptional

Time at which the order was created.

Example: 2018-04-25T20:37:00Z
post
/orders/{id}/refresh

hashtag
Lists an order's tax details

get

Retrieves the tax details of each line item in an order. You're required to specify the order's identifier as a path parameter.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Order ID

Responses
chevron-right
200

OK.

application/json

The tax details of each line item in an order.

orderIdstringOptional

The unique identifier of the order.

Example: ord_5823594809
get
/orders/{id}/tax-details
PreviousLogistics returnsNextOrder basics

Last updated