Sales summaries

Sales Summaries provide a comprehensive overview of your transaction data daily. Managed and compiled by Digital River, these summaries offer easy access to detailed sales information, empowering businesses to effortlessly monitor and analyze their financial performance. Users can retrieve specific sales summaries or access a complete list to gain insights into daily sales activity, enabling data-driven decisions and strategic planning. See Sales summaries for more information.

PreviousReturns NextSales transactions

Last updated 4 months ago

Returns a list of sales summaries

Get all sales summaries.

get

/sales-summaries

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.

salesClosingTimeobject

A filter on the list based on the sales summary salesClosingTime 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 salesClosingTime field is after this timestamp
gte - return values where the salesClosingTime field is after or equal to this timestamp
lt - return values where the salesClosingTime field is before this timestamp
lte - return values where the salesClosingTime field is before or equal to this timestamp

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

paidstring

Only return sales summaries which have been paid

payoutIdstring

Only return sales summaries with this payout identifier

currencystring

Only return sales summaries in the given currency

amountobject

A filter on the list based on the sales summaries 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

payerIdstring

Only return sales summaries with this payer identifier

payerNamestring

Only return sales summaries with this payer name

payeeIdstring

Only return sales summaries with this payee identifier

payeeNamestring

Only return sales summaries with this payee name

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

405

406

408

429

500

502

503

504

{
  "hasMore": true,
  "data": [
    {
      "id": "8100000400_1410_2019",
      "createdTime": "2019-04-25T20:36:00Z",
      "salesClosingTime": "2019-04-25T00:00:00Z",
      "currency": "USD",
      "amount": 1180.26,
      "payoutId": "2000028600_1410_2019",
      "paid": true,
      "payerId": "1410",
      "payerName": "DR globalTech, Inc.",
      "payeeId": "0013900100",
      "payeeName": "ACME, Inc.",
      "liveMode": true
    }
  ]
}

200 OK

Gets a sales summary by ID

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

get

/sales-summaries/{id}