Returning a list of sales summaries
Learn how to return a list of sales summaries.
Parameter | Optional/Required | Description |
---|---|---|
createdTime | Optional | A filter on the list based on the createdTime field. The value can be a string with an ISO-601 UTC format datetime, or it can be a dictionary with the following options:
|
endingBefore | Optional | A cursor for use in pagination. The endingBefore parameter is an object identifier 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 to fetch the previous page of the list. |
startingAfter | Optional | A cursor for use in pagination. The startingAfter parameter is an object identifier 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 to fetch the next page of the list. |
limit | Optional | A limit on the number of objects returned. The limit can range between 1 and 100, and the default is 10. |
ids | Optional | Only return objects with these identifiers. |
salesClosingTime | Optional | 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:
|
paid | Optional | Only return sales summaries that have been paid. |
payoutId | Optional | Only return sales summaries with this payout identifier. |
currency | Optional | Only return sales summaries in this currency. |
amount | Optional | 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:
|
payerId | Optional | Only return sales summaries with this payer identifier. |
payerName | Optional | Only return sales summaries with this payer name. |
payeeId | Optional | Only return sales summaries with this payee identifier. |
payeeName | Optional | Only return sales summaries with this payee name. |
Retrieve the details of sales summaries with a
GET
request:cURL
curl https://api.digitalriver.com/sales-summaries
JSON
{
"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
}
]
}
The following information provides details on the key attributes returned in response to a request for sales summaries information. For a complete list, refer to the Sales summaries API reference.
A unique identifier for the sales summary.
The time at which the sales summary was created in the reporting environment
The end date of that sales summary time frame as defined in the reporting environment.
The three-letter ISO currency code representing the currency used in sales summary reporting.
Represents the total sales summary amount reported in the requested currency.
A unique identifier for a payout associated with the specific sales summary. Sales summaries are initially created without a
payoutId
. The value is updated when the sales summary is paid.A unique identifier for a payout associated with the specific sales summary. Sales summaries are initially created without a
payoutId
. The value is updated when the sales summary is paid..If the value is True, it indicates that this sales summary has been paid. This value is useful for creating a filter in choosing data for a report.
The ID of payer.
The name of the payer.
The ID of the payee.
If the value is True, the object exists in live mode. If the value is False, the object exists in a test mode. Only live mode is supported.
Last modified 2mo ago