Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Sales transactions

Gets a sales transaction by ID

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

get/sales-transactions/{id}

Path parameters

idstring required

Sales transaction ID

Response

OK.

idstring

Unique identifier for the sales transaction

createdTimestring date-time

Time at which the sales transaction was created

updatedTimestring date-time

Time at which the sales transaction was last updated.

saleTimestring date-time

Time at which the sales occurred.

salesSummaryIdstring

Unique identifier of a Digital River sales summary, if any.

currencystring

Three-letter ISO currency code representing the sale currency.

amountnumber double

The sales transaction amount.

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

Sales transaction type.

orderIdstring

Order identifier.

skuIdstring

SKU identifier.

quantitynumber double

The quantity of the SKU.

payerIdstring

The ID of payer.

payerNamestring

The name of the payer

payeeIdstring

The ID of the payee.

payeeNamestring

The name of the payee.

liveModeboolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

orderUpstreamIdstring

Unique upstream ID for the order.

skuTaxCodestring

The sku tax code.

shipFromCountrystring

Country being shipped from.

shipToCountrystring

Country being shipped to.

billToCountrystring

Country listed on shopper's billing address.

shipFromStatestring

The state, county, province, or region being shipped from.

shipToStatestring

The state, county, province, or region being shipped to.

billToStatestring

The state, county, province, or region being billed to.

paymentTypestring

Type of payment used.

lineItemIdstring

The unique identiier of the line item.

orderMetadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

lineItemMetadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

Example response

{
  "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"
  }
}