Sales transactions

Sales Transactions in the Digital River API provide a detailed record of costed sales, allowing you to track and manage individual or multiple transactions effectively. This resource offers robust tools for retrieving sales data, which is essential for financial analysis and reporting. By leveraging these transactions, businesses can gain insights into their sales performance and optimize their revenue streams. See for more information.

PreviousSales summaries NextShipments

Last updated 3 months ago

Returns a list of sales transactions

Get all sales transactions.

get

/sales-transactions

Authorizations

Query parameters

createdTimeobject

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:

gt—return values where the createdTime field is after this timestamp
gte—return values where the createdTime field is after or equal to this timestamp
lt—return values where the createdTime field is before this timestamp
lte—return values where the createdTime field is before or equal to this timestamp

Example: createdTime[gt]=2020-09-22T12:09:44Z

endingBeforestring

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.

startingAfterstring

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.

idsstring[]

Only return objects with these IDs.

limitinteger · min: 1 · max: 5000

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

saleTimeobject

A filter on the list based on the sales transaction saleTime field. The value can be a string with an ISO-601 UTC format datetime or it can be a dictionary with the following options:

gt - return values where the saleTime field is after this timestamp
gte - return values where the saleTime field is after or equal to this timestamp
lt - return values where the saleTime field is before this timestamp
lte - return values where the saleTime field is before or equal to this timestamp

Example: 2018-03-25T20:36:00Z

salesSummaryIdstring

Only return sales transactions with this sales summary identifier

orderUpstreamIdstring

Only return sales transactions with this order upstream identifier

paymentTypestring

Only return sales transactions with this payment type

typestring · enum

Only return sales transactions of this type

Options: sale, replacement, replacement_refund, replacement_return, fraud_chargeback, non_fraud_chargeback, refund, return, fraud_detection, declined_settlement

currencystring

Only return sales transactions in this currency

orderIdstring

Only return sales transactions with this order identifier

skuIdstring

Only return sales transactions with this sku identifier

quantityobject

A filter on the list based on the sales transaction quantity field. The value can be a string or it can be a dictionary with the following options:

gt - return values where the quantity field is greater than this amount
gte - return values where the quantity field is greater than or equal to this amount
lt - return values where the quantity field is less than this amount
lte - return values where the quantity field is less than or equal to this amount

Example: 2

amountobject

A filter on the list based on the sales transaction amount field. The value can be a string or it can be a dictionary with the following options:

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

Example: 20.99

digitalRiverShareobject

A filter on the list based on the sales transaction Digital River share field. The value can be a string or it can be a dictionary with the following options:

gt - return values where the Digital River share field is greater than this amount
gte - return values where the Digital River share field is greater than or equal to this amount
lt - return values where the Digital River share field is less than this amount
lte - return values where the Digital River share field is less than or equal to this amount

Example: 20.99

payoutAmountobject

A filter on the list based on the sales transaction payoutAmount field. The value can be a string or it can be a dictionary with the following options:

gt - return values where the payoutAmount field is greater than this amount
gte - return values where the payoutAmount field is greater than or equal to this amount
lt - return values where the payoutAmount field is less than this amount
lte - return values where the payoutAmount field is less than or equal to this amount

Example: 20.99

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.digitalriver.com/sales-transactions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

405

406

408

429

500

502

503

504

{
  "hasMore": true,
  "data": [
    {
      "id": "0206802584_000010_3700005504",
      "createdTime": "2019-04-25T20:36:00Z",
      "updatedTime": "2018-04-25T20:36:00Z",
      "saleTime": "2019-04-25T00:00:00Z",
      "salesSummaryId": "8100000400_1410_2019",
      "currency": "GBP",
      "amount": 443.08,
      "orderId": "37031462099",
      "skuId": "945-0198",
      "quantity": 1,
      "payoutAmounts": {
        "currency": "USD",
        "exchangeRate": 1.24535,
        "amount": 551.79,
        "tax": -91.97,
        "shipping": -14.36,
        "regulatoryFees": 0,
        "landedCost": 0,
        "productPrice": 445.46,
        "digitalRiverShare": -41.38,
        "distributorShare": -375.61,
        "transactionFees": 0,
        "shippingDiscount": 0,
        "regulatoryFeeDiscount": 0,
        "remitShipping": 0,
        "remitLandedCost": 0,
        "payoutAmount": 28.47,
        "storeCredit": 23.41
      },
      "payerId": "1410",
      "payerName": "DR globalTech, Inc.",
      "payeeId": "0013900100",
      "payeeName": "ACME, Inc.",
      "liveMode": true,
      "orderUpstreamId": "fe18c37b-f76b-4eaa-892a-b1aca88cf46d",
      "skuTaxCode": "4323.310_A",
      "shipFromCountry": "US",
      "shipToCountry": "NL",
      "billToCountry": "US",
      "shipFromState": "MN",
      "shipToState": "MN",
      "billToState": "MN",
      "paymentType": "creditCard",
      "lineItemId": "51885630082",
      "orderMetadata": {
        "coupon": "iOS"
      },
      "lineItemMetadata": {
        "coupon": "iOS"
      },
      "type": "sale"
    }
  ]
}

200 OK

Gets a sales transaction by ID

Retrieves the details of a sales transaction. Supply the unique identifier of the sales transaction.

get

/sales-transactions/{id}

Authorizations

Path parameters

idstringrequired

Sales transaction ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.digitalriver.com/sales-transactions/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

405

406

408

429

500

502

503

504

{
  "id": "0206802584_000010_3700005504",
  "createdTime": "2019-04-25T20:36:00Z",
  "updatedTime": "2018-04-25T20:36:00Z",
  "saleTime": "2019-04-25T00:00:00Z",
  "salesSummaryId": "8100000400_1410_2019",
  "currency": "GBP",
  "amount": 443.08,
  "orderId": "37031462099",
  "skuId": "945-0198",
  "quantity": 1,
  "payoutAmounts": {
    "currency": "USD",
    "exchangeRate": 1.24535,
    "amount": 551.79,
    "tax": -91.97,
    "shipping": -14.36,
    "regulatoryFees": 0,
    "landedCost": 0,
    "productPrice": 445.46,
    "digitalRiverShare": -41.38,
    "distributorShare": -375.61,
    "transactionFees": 0,
    "shippingDiscount": 0,
    "regulatoryFeeDiscount": 0,
    "remitShipping": 0,
    "remitLandedCost": 0,
    "payoutAmount": 28.47,
    "storeCredit": 23.41
  },
  "payerId": "1410",
  "payerName": "DR globalTech, Inc.",
  "payeeId": "0013900100",
  "payeeName": "ACME, Inc.",
  "liveMode": true,
  "orderUpstreamId": "fe18c37b-f76b-4eaa-892a-b1aca88cf46d",
  "skuTaxCode": "4323.310_A",
  "shipFromCountry": "US",
  "shipToCountry": "NL",
  "billToCountry": "US",
  "shipFromState": "MN",
  "shipToState": "MN",
  "billToState": "MN",
  "paymentType": "creditCard",
  "lineItemId": "51885630082",
  "orderMetadata": {
    "coupon": "iOS"
  },
  "lineItemMetadata": {
    "coupon": "iOS"
  },
  "type": "sale"
}

OK.