Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Sales transactions

Returns a list of sales transactions

Get all sales transactions.

get/sales-transactions

Query parameters

createdTimeobject

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
endingBeforestring

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.

startingAfterstring

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

Only return objects with these IDs.

limitinteger

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

saleTimeobject

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
salesSummaryIdstring

Only return sales transactions with this sales summary identifier

orderUpstreamIdstring

Only return sales transactions with this order upstream identifier

paymentTypestring

Only return sales transactions with this payment type

type'sale' | 'replacement' | 'replacement_refund' | 'replacement_return' | 'fraud_chargeback' | 'non_fraud_chargeback' | 'refund' | 'return' | 'fraud_detection' | 'declined_settlement'

Only return sales transactions of this type

currencystring

Only return sales transactions in this currency

orderIdstring

Only return sales transactions with this order identifier

skuIdstring

Only return sales transactions with this sku identifier

quantityobject

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
amountobject

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
digitalRiverShareobject

A filter on the list based on the sales transaction Digital River share field. The value can be a string or it can be a dictionary with the following options:

  • gt - return values where the Digital River share field is greater than this amount
  • gte - return values where the Digital River share field is greater than or equal to this amount
  • lt - return values where the Digital River share field is less than this amount
  • lte - return values where the Digital River share field is less than or equal to this amount
payoutAmountobject

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

Response

200 OK

hasMoreboolean

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

Example response

{
  "hasMore": true,
  "data": [
    {
      "id": "0206802584_000010_3700005504",
      "createdTime": "2019-04-25T20:36:00Z",
      "updatedTime": "2018-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,
        "productPrice": 445.46,
        "digitalRiverShare": -41.38,
        "distributorShare": -375.61,
        "payoutAmount": 28.47,
        "storeCredit": 23.41
      },
      "payerId": "1410",
      "payerName": "DR globalTech, Inc.",
      "payeeId": "0013900100",
      "payeeName": "ACME, Inc.",
      "liveMode": true,
      "orderUpstreamId": "fe18c37b-f76b-4eaa-892a-b1aca88cf46d",
      "skuTaxCode": "4323.310_A",
      "shipFromCountry": "US",
      "shipToCountry": "NL",
      "billToCountry": "US",
      "shipFromState": "MN",
      "shipToState": "MN",
      "billToState": "MN",
      "paymentType": "creditCard",
      "lineItemId": "51885630082",
      "orderMetadata": {
        "coupon": "iOS"
      },
      "lineItemMetadata": {
        "coupon": "iOS"
      }
    }
  ]
}