Returning a list of sales transactions

Learn how to get a list of sales transactions.

Setting the sales transaction query parameters
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:
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
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.
saleTime
Optional
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
salesSummaryId
​
Only return sales transactions with this sales summary identifier.
type
Optional
Only return sales transactions of this type. The enum are sale, replacement, replacement_refund, replacement, replacement_return, fraud_chargeback, non_fraud_chargeback, refund, return, fraud_detection, or declined_settlement.
currency
Optional
Only return sales transactions in this currency.
orderId
Optional
Only return sales transactions with this order identifier.
skuId
Optional
Only return sales transactions with this SKU identifier.
quantity
Optional
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
amount
Optional
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
digitalRiverShare
Optional
A filter on the list based on the sales transaction digitalRiverShare field. The value can be a string, or it can be a dictionary with the following options:
gt–return values where the digitalRiverSharefield is greater than this amount
gte–return values where the digitalRiverSharefield is greater than or equal to this amount
lt–return values where the digitalRiverSharefield is less than this amount
lte–return values where the digitalRiverSharefield is less than or equal to this amount
payoutAmount
Optional
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 get request and response
Retrieve the details of sales transactions with a GET request:
cURL
curl https://api.digitalriver.com/sales-transactions
A 200 OK response returns an array of Sales Transaction objects:
JSON
{
  "hasMore": true,
  "data": [
    {
      "id": "0206802584_000010_3700005504",
      "createdTime": "2019-04-25T20:36:00Z",
      "saleTime": "2019-04-25T00:00:00Z",
      "salesSummaryId": "8100000400_1410_2019",
      "currency": "GBP",
      "amount": 443.08,
      "type": "sale",
      "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,
        "payoutAmount": 28.47
      },
      "payerId": "1410",
      "payerName": "DR globalTech, Inc.",
      "payeeId": "0013900100",
      "payeeName": "ACME, Inc.",
      "liveMode": true
      "orderMetadata": {
          "coupon": "iOS"
      },
      "lineItemMetadata": {
          "coupon": "iOS"
      }
  ]
}
Key sales transaction attributes
The following information provides you with details on the key attributes returned in response to a request for a sales transaction information. For a complete details, refer to the Sales transactions API reference.
id
A unique identifier for a sales transaction. A sales transaction can be defined as a fulfilled sales order line. 

Sales transactions are created at the fulfillment level. As an example, let's say you have an order with line item 1 one and line item 2. If you just fulfill line item 1, you'll see a single sales transaction. If you fulfill only half of the quantity of line item 2, you'll see another sales transaction created. When you finally fulfill the other half of the quantity of line 2, you will see a third new sales transaction.
createdTime
The time at which the sales transaction was created in the reporting environment.
saleTime
The time when the order line item was fulfilled. Sales transactions are handled at the fulfillment level. As an example, let's say you have an order with line item 1 and line item 2. If you just fulfill line item 1, you'll see a single sales transaction. If you fulfill only half of the quantity of line item 2, you'll see another sales transaction created. When you finally fulfill the other half of the quantity of line 2, you will again see a new sales transaction.
salesSummaryId
A unique identifier for a sales summary associated with the specific sales transaction. Sales transactions are initially created without a salesSummaryId. This value is updated when the sales transaction is grouped with other sales transactions into a sales summary.
orderUpstreamId
A unique identifier generated by the upstream application or commerce platform.
currency
The three-letter ISO currency code representing the type of currency used in the sales transaction.
amount
The sales transaction total amount in the customer's currency. This amount multiplied by the payoutAmounts.exchangeRate (see below) gives you the payoutAmounts.amount in the requested payout currency.
type
Designates the type of transaction. Supported types are sale, return, refund, fraud_chargeback, and non_fraud_chargeback.
orderId
A unique identifier for the order.
skuId
A unique identifier for the SKU.
quantity
The quantity fulfilled for that SKU.
payoutAmounts.
This section of returned data describes all information related to the payout amount of a sales transaction. For example, in the payout process you might sell something in Norwegian kroner but in the payout step of the sales transaction, it would be converted to U.S. dollars if that is the requested payout currency.
payoutAmounts.currency 
The three-letter ISO currency code representing the type of currency to be used in the sales transaction payout.
payoutAmounts.exchangeRate
The exchange rate used convert the sales amount from the sales order currency into the payout currency. Theamount (above) multiplied by the payoutAmounts.exchangeRate (see below) gives you the payoutAmounts.amount.
payoutAmounts.amount
The amount charged to the shopper for the fulfilled line item. The amount(see above) multiplied by the payoutAmounts.exchangeRate (see below) gives you the payoutAmounts.amount.
payoutAmounts.tax 
The sales transaction tax amount in the currency used for the payout. The payoutAmounts.amount minus the payout tax, shipping, regulatory fees, and landed costs gets you thepayoutAmounts.productPrice.
payoutAmounts.shipping 
The sales transaction shipping amount in the currency used for the payout. The payoutAmounts.amount minus payout tax, shipping, regulatory fees, and landed costs gets you thepayoutAmounts.productPrice.
payoutAmounts.regulatoryFees 
The regulatory fees amount in the currency used for the payout. The payoutAmounts.amount  minus payout tax, shipping, regulatory fees, and landed costs gets you thepayoutAmounts.productPrice.
payoutAmounts.landedCost 
The landed costs amount. The payoutAmounts.amountminus payout tax, shipping, regulatory fees, and landed costs gets you the payoutAmounts.productPrice.
payoutAmounts.productPrice 
The product price that does not include any taxes or fees. The payoutAmounts.amount minus payout tax, shipping, regulatory fees, and landed costs gets you the payoutAmounts.productPrice.
payoutAmounts.digitalRiverShare 
The margin that Digital River receives for services. The payoutAmounts.productPrice plus or minus the Digital River share, transaction fees, shipping discount, regulatory fee discount, and the shipping remittance amount gets you the total payout amount payoutAmounts.payoutAmount. 
payoutAmounts.distributorShare
The distributor share amount. This is always a value of "0."
payoutAmounts.transactionFees
The transaction fees amount. The payoutAmounts.productPrice plus or minus the Digital River share, transaction fees, shipping discount, regulatory fee discount, and the shipping remittance amount gets you the total payout amount payoutAmounts.payoutAmount. 
payoutAmounts.shippingDiscount 
The shipping discount amount. The payoutAmounts.productPrice plus or minus the Digital River share, transaction fees, shipping discount, regulatory fee discount and the shipping remittance amount gets you the total payout amount payoutAmounts.payoutAmount.
payoutAmounts.regulatoryFeeDiscount
The regulatory fee discount amount. The payoutAmounts.productPrice plus or minus the Digital River share, transaction fees, shipping discount, regulatory fee discount, and the shipping remittance amount gets you the total payout amount payoutAmounts.payoutAmount.
payoutAmounts.remitShipping 
The shipping remittance amount. The payoutAmounts.productPrice plus or minus the Digital River share, transaction fees, shipping discount, regulatory fee discount, and the shipping remittance amount gets you the total payout amount payoutAmounts.payoutAmount.
payoutAmounts.payoutAmount 
Total payout amount. The payoutAmounts.productPrice plus or minus the Digital River share, transaction fees, shipping discount, regulatory fee discount, and the shipping remittance amount gets you the total payout amount payoutAmounts.payoutAmount.
payerId
The ID of payer. 
payerName
The name of the payer 
payeeId
The ID of the payee. 
payeeName
The name of the payee. 
liveMode
If the value is True, the object exists in live mode. If the value is False, the object exists in test mode. Only live mode is supported.
orderMetadata
Key-value pairs used to store additional order level data. The value can be string, boolean, or integer types.
lineItemMetadata
Key-value pairs used to store additional line-item level data. The value can be string, boolean, or integer types.

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: 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
`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.
`saleTime`	Optional	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
`salesSummaryId`		Only return sales transactions with this sales summary identifier.
`type`	Optional	Only return sales transactions of this type. The enum are `sale, replacement, replacement_refund`, `replacement`, `replacement_return`, `fraud_chargeback`, `non_fraud_chargeback`, `refund`, `return`, `fraud_detection`, or `declined_settlement`.
`currency`	Optional	Only return sales transactions in this currency.
`orderId`	Optional	Only return sales transactions with this order identifier.
`skuId`	Optional	Only return sales transactions with this SKU identifier.
`quantity`	Optional	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
`amount`	Optional	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
`digitalRiverShare`	Optional	A filter on the list based on the sales transaction `digitalRiverShare` field. The value can be a string, or it can be a dictionary with the following options: gt–return values where the `digitalRiverShare`field is greater than this amount gte–return values where the `digitalRiverShare`field is greater than or equal to this amount lt–return values where the `digitalRiverShare`field is less than this amount lte–return values where the `digitalRiverShare`field is less than or equal to this amount
`payoutAmount`	Optional	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

Financial reporting - Previous

Sales transactions

Getting a sales transaction by ID

Last modified 2mo ago