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

bearerAuth

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.

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.

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

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

hasMorebooleanOptional

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

Example: true

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

/sales-summaries

HTTPcURLJavaScriptPython

GET /sales-summaries HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "hasMore": true,
  "data": [
    {
      "id": "8100000400_1410_2019",
      "createdTime": {
        "offset": {
          "totalSeconds": 0,
          "id": "Z",
          "rules": {
            "fixedOffset": true,
            "transitions": [],
            "transitionRules": []
          }
        },
        "nano": 0,
        "year": 2019,
        "monthValue": 4,
        "dayOfMonth": 25,
        "hour": 20,
        "minute": 36,
        "second": 0,
        "dayOfWeek": "THURSDAY",
        "dayOfYear": 115,
        "month": "APRIL"
      },
      "salesClosingTime": {
        "offset": {
          "totalSeconds": 0,
          "id": "Z",
          "rules": {
            "fixedOffset": true,
            "transitions": [],
            "transitionRules": []
          }
        },
        "nano": 0,
        "year": 2019,
        "monthValue": 4,
        "dayOfMonth": 25,
        "hour": 0,
        "minute": 0,
        "second": 0,
        "dayOfWeek": "THURSDAY",
        "dayOfYear": 115,
        "month": "APRIL"
      },
      "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

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Sales summary ID

Responses

200

OK.

application/json

idstringRead-onlyOptional

Unique identifier for the sales summary

Example: 8100000400_1410_2019

createdTimestring · date-timeRead-onlyOptional

Time at which the sales summary was created

Example: {"offset":{"totalSeconds":0,"id":"Z","rules":{"fixedOffset":true,"transitions":[],"transitionRules":[]}},"nano":0,"year":2019,"monthValue":4,"dayOfMonth":25,"hour":20,"minute":36,"second":0,"dayOfWeek":"THURSDAY","dayOfYear":115,"month":"APRIL"}

salesClosingTimestring · date-timeRead-onlyOptional

Time at which the sales summary was closed

Example: {"offset":{"totalSeconds":0,"id":"Z","rules":{"fixedOffset":true,"transitions":[],"transitionRules":[]}},"nano":0,"year":2019,"monthValue":4,"dayOfMonth":25,"hour":0,"minute":0,"second":0,"dayOfWeek":"THURSDAY","dayOfYear":115,"month":"APRIL"}

currencystringOptional

Three-letter ISO currency code representing the sales summary currency.

Example: USD

amountnumber · doubleRead-onlyOptional

Represents the total sales summary amount.

Example: 1180.26

payoutIdstringRead-onlyOptional

Payout identifier

Example: 2000028600_1410_2019

paidbooleanOptional

If true, indicates that this sales summary has been paid.

Example: true

payerIdstringOptional

The ID of payer.

Example: 1410

payerNamestringOptional

The name of the payer

Example: DR globalTech, Inc.

payeeIdstringOptional

The ID of the payee.

Example: 0013900100

payeeNamestringOptional

The name of the payee.

Example: ACME, Inc.

liveModebooleanOptional

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

Example: true

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

/sales-summaries/{id}

HTTPcURLJavaScriptPython

GET /sales-summaries/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "8100000400_1410_2019",
  "createdTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    },
    "nano": 0,
    "year": 2019,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "THURSDAY",
    "dayOfYear": 115,
    "month": "APRIL"
  },
  "salesClosingTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    },
    "nano": 0,
    "year": 2019,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 0,
    "minute": 0,
    "second": 0,
    "dayOfWeek": "THURSDAY",
    "dayOfYear": 115,
    "month": "APRIL"
  },
  "currency": "USD",
  "amount": 1180.26,
  "payoutId": "2000028600_1410_2019",
  "paid": true,
  "payerId": "1410",
  "payerName": "DR globalTech, Inc.",
  "payeeId": "0013900100",
  "payeeName": "ACME, Inc.",
  "liveMode": true
}