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 |
---|---|---|
| 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:
|
| Optional | A cursor for use in pagination. The |
| Optional | A cursor for use in pagination. The |
| Optional | A limit on the number of objects returned. The limit can range between 1 and 100, and the default is 10. |
| Optional | Only return objects with these identifiers. |
| Optional | A filter on the list based on the sales transaction
|
| Only return sales transactions with this sales summary identifier. | |
| Optional | Only return sales transactions of this type. The enum are |
| Optional | Only return sales transactions in this currency. |
| Optional | Only return sales transactions with this order identifier. |
| Optional | Only return sales transactions with this SKU identifier. |
| Optional | A filter on the list based on the sales transaction
|
| Optional | A filter on the list based on the sales transaction
|
| Optional | A filter on the list based on the sales transaction
|
| Optional | A filter on the list based on the sales transaction
|
Example get request and response
Retrieve the details of sales transactions with a GET
request:
A 200 OK
response returns an array of Sales Transaction objects:
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.amount
minus 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.
Last updated