Sales transactions

Sales Transactions in the Digital River API provide a detailed record of costed sales, allowing you to track and manage individual or multiple transactions effectively. This resource offers robust tools for retrieving sales data, which is essential for financial analysis and reporting. By leveraging these transactions, businesses can gain insights into their sales performance and optimize their revenue streams.

Returns a list of sales transactions

get

Get all sales transactions.

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

salesSummaryIdstringOptional

Only return sales transactions with this sales summary identifier

orderUpstreamIdstringOptional

Only return sales transactions with this order upstream identifier

paymentTypestringOptional

Only return sales transactions with this payment type

typestring · enumOptional

Only return sales transactions of this type

Possible values:
currencystringOptional

Only return sales transactions in this currency

orderIdstringOptional

Only return sales transactions with this order identifier

skuIdstringOptional

Only return sales transactions with this sku identifier

Responses
200
200 OK
application/json
get
GET /sales-transactions HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "hasMore": true,
  "data": [
    {
      "id": "0206802584_000010_3700005504",
      "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"
      },
      "saleTime": {
        "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"
      },
      "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,
        "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",
      "paymentType": "creditCard"
    }
  ]
}

Gets a sales transaction by ID

get

Retrieves the details of a sales transaction. Supply the unique identifier of the sales transaction.

Authorizations
Path parameters
idstringRequired

Sales transaction ID

Responses
200
OK.
application/json
get
GET /sales-transactions/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "0206802584_000010_3700005504",
  "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"
  },
  "saleTime": {
    "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"
  },
  "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,
    "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",
  "paymentType": "creditCard"
}

Last updated