LogoLogo
System Status
2020-09-30
2020-09-30
  • 2020-09-30
  • Charges
  • Checkouts
  • Country specification
  • Customers
  • Events
  • Fees
  • File links
  • Files
  • Fulfillments
  • Invoices
  • Orders
  • Payouts
  • Refunds
  • Returns
  • SKUs
  • Sales summaries
  • Sales transactions
  • Sources
  • Webhooks
Powered by GitBook
On this page

Sales summaries

PreviousSKUsNextSales transactions

Last updated 5 months ago

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 monitor and analyze their financial performance effortlessly. 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.

Returns a list of sales summaries

get

Get all sales summaries.

Authorizations
Query parameters
createdTimestring · date-timeOptional

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

idsstring[]Optional

Only return objects with these IDs.

limitinteger · min: 1 · max: 5000Optional

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

salesClosingTimestring · date-timeOptional

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
paidstringOptional

Only return sales summaries which have been paid

payoutIdstringOptional

Only return sales summaries with this payout identifier

currencystringOptional

Only return sales summaries in the given currency

amountstringOptional

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
payerIdstringOptional

Only return sales summaries with this payer identifier

payerNamestringOptional

Only return sales summaries with this payer name

payeeIdstringOptional

Only return sales summaries with this payee identifier

payeeNamestringOptional

Only return sales summaries with this payee name

Responses
200
200 OK
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
get
GET /sales-summaries HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "hasMore": true,
  "data": [
    {
      "id": "8100000400_1410_2019",
      "createdTime": "2025-05-09T05:15:37.650Z",
      "salesClosingTime": "2025-05-09T05:15:37.650Z",
      "currency": "USD",
      "amount": 1180.26,
      "payoutId": "2000028600_1410_2019",
      "paid": true,
      "payerId": "1410",
      "payerName": "DR globalTech, Inc.",
      "payeeId": "0013900100",
      "payeeName": "ACME, Inc.",
      "liveMode": true
    }
  ]
}

Gets a sales summary by ID

get

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

Authorizations
Path parameters
idstringRequired

Sales summary ID

Responses
200
OK.
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
404
404 Not Found
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
get
GET /sales-summaries/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "8100000400_1410_2019",
  "createdTime": "2025-05-09T05:15:37.650Z",
  "salesClosingTime": "2025-05-09T05:15:37.650Z",
  "currency": "USD",
  "amount": 1180.26,
  "payoutId": "2000028600_1410_2019",
  "paid": true,
  "payerId": "1410",
  "payerName": "DR globalTech, Inc.",
  "payeeId": "0013900100",
  "payeeName": "ACME, Inc.",
  "liveMode": true
}
  • GETReturns a list of sales summaries
  • GETGets a sales summary by ID