Retrieve an order (synchronous API)

Get an order's details

Retrieve an order's details by specifying the order ID in the {orderId} URI path parameter.

GEThttps://api.digitalriver.com/v1/orders/{orderId}

Authorization

SystemApiKey

Path parameters

orderId*string

The order's ID.

Response

200400401404

Successful response.

Body

application/json

idstring

The identifier of the order.

Example: "1067669580082"

totalItemsInCartinteger

Total items in the cart.

Example: 1

testOrderboolean

The order is a test order or not.

Example: false

sendEmailboolean

Send email notification to the customer or not.

Example: false

localestring

The locale of the order.

Example: "en_US"

currencystring

The currency of the order.

Example: "USD"

taxExemptboolean

Tax exempted or not of the order.

Example: false

shopperLoginTypestring

The shopper login type used when the order was placed. "Anonymous" means the user didn't create or log on to their shopper account. "Authenticated" means the shopper logged on to their shopper account.

Example: "Anonymous"

shopperIdstring

The identifier of the shopper.

Example: "42317897435"

softDescriptorstring

The name that will appear on the customer's credit card statement. If the descriptor contains "DR*" it means that Digital River is the Merchant of Record (MoR) for the order.

Example: ""

orderStatestring

Specifies the current state of the order. The possible values are as follows. Open, In Process, Cancelled, or Submitted.

Example: "Completed"

lineItemsarray of object

pricingobject

businessEntityCodestring

The business entity code of the order

Example: "DR_IRELAND-ENTITY"

paymentMethodsarray of object

shippingMethodobject

The shipping method of the order.

billingAddressobject

The customer's billing address.

shippingAddressobject

The customer's shipping address.

taxRegistrationsarray of object

taxInclusiveboolean

The price list setup for the currency.

• If true, the price list is set to tax inclusive.
• If false, the price list is set to tax exclusive.

Example: false

submissionDatestring (date-time)

The date when the order was placed.

requestToBeForgottenstring (date-time)

This data is only presented when a request for the removal of personal identifiable information has been made previously.

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/orders/{orderId}', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

200400404

{
  "id": "1067669580082",
  "totalItemsInCart": 1,
  "testOrder": false,
  "sendEmail": false,
  "locale": "en_US",
  "currency": "USD",
  "taxExempt": false,
  "shopperLoginType": "Anonymous",
  "shopperId": "42317897435",
  "softDescriptor": "",
  "orderState": "Completed",
  "lineItems": [
    {
      "id": "52467820082",
      "quantity": 1,
      "lineItemState": "Submitted",
      "product": {
        "id": "5145984800",
        "sku": "sku",
        "displayName": "Physical Product",
        "systemProductName": "Physical Product"
      },
      "pricing": {
        "netPrice": {
          "value": 100
        },
        "listPrice": {
          "value": 100
        },
        "salePriceWithQuantity": {
          "value": 100
        },
        "totalDiscountWithQuantity": {
          "value": 0
        },
        "importTax": {
          "value": 0
        },
        "importDuty": {
          "value": 0
        }
      },
      "subscriptions": [
        {
          "id": "10007820082",
          "expirationDate": {
            "offset": {
              "totalSeconds": 0,
              "id": "Z",
              "rules": {
                "transitions": [],
                "transitionRules": [],
                "fixedOffset": true
              }
            },
            "nano": 0,
            "year": 2023,
            "monthValue": 2,
            "dayOfMonth": 27,
            "hour": 20,
            "minute": 36,
            "second": 2,
            "month": "FEBRUARY",
            "dayOfWeek": "MONDAY",
            "dayOfYear": 58
          }
        }
      ],
      "downloads": [
        {
          "downloadUri": "https://wgt.digitalriver.com/wgt/9B5A1DA80C/B5E89D92/paytest/testdownload22222.txt"
        }
      ],
      "digitalRights": [
        {
          "unlockCode": "unlockCode"
        }
      ]
    }
  ],
  "pricing": {
    "total": {
      "value": 122
    },
    "subTotal": {
      "value": 100
    },
    "subtotalWithDiscount": {
      "value": 100
    },
    "shippingAndHandling": {
      "value": 0
    },
    "discount": {
      "value": 0
    },
    "tax": {
      "value": 22
    },
    "importTaxAndDuty": {
      "value": 0
    },
    "fees": {
      "value": 0
    }
  },
  "businessEntityCode": "DR_IRELAND-ENTITY",
  "paymentMethods": [
    {
      "type": "creditCard",
      "sourceId": "31674ac7-09bf-463b-b22b-eef835c6feed",
      "sourceClientSecret": "31674ac7-09bf-463b-b22b-eef835c6feed_e5d0257c-107d-4515-b732-521a05cb4b6f",
      "creditCard": {
        "expirationYear": "2030",
        "lastFourDigits": "1111",
        "clientSecret": "31674ac7-09bf-463b-b22b-eef835c6feed_e5d0257c-107d-4515-b732-521a05cb4b6f",
        "expirationMonth": "expirationMonth",
        "brand": "AmericanExpress",
        "flow": "standard",
        "reusable": false
      },
      "amountContributed": {
        "currency": "USD",
        "value": 97
      }
    }
  ],
  "shippingMethod": {
    "code": 265200,
    "description": "Standard"
  },
  "billingAddress": {
    "title": "title",
    "firstName": "firstName",
    "lastName": "lastName",
    "line1": "line1",
    "line2": "line2",
    "city": "city",
    "postalCode": "00187",
    "country": "IT",
    "countryName": "Italy",
    "phoneNumber": "06 6780691",
    "emailAddress": "[e-mail]",
    "companyName": "companyName",
    "countrySubdivision": "countrySubdivision",
    "countyName": "countyName",
    "phoneticFirstName": "phoneticFirstName",
    "phoneticLastName": "phoneticLastName",
    "division": "division"
  },
  "shippingAddress": {
    "title": "title",
    "firstName": "firstName",
    "lastName": "lastName",
    "line1": "line1",
    "line2": "line2",
    "city": "city",
    "postalCode": "00187",
    "country": "IT",
    "countryName": "Italy",
    "phoneNumber": "06 6780691",
    "emailAddress": "[e-mail]",
    "companyName": "companyName",
    "countrySubdivision": "countrySubdivision",
    "countyName": "countyName",
    "phoneticFirstName": "phoneticFirstName",
    "phoneticLastName": "phoneticLastName",
    "division": "division"
  },
  "taxRegistrations": [
    {
      "key": "IT_VAT2",
      "value": "IT12345678901"
    }
  ],
  "taxInclusive": false,
  "submissionDate": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "transitions": [],
        "transitionRules": [],
        "fixedOffset": true
      }
    },
    "nano": 0,
    "year": 2023,
    "monthValue": 2,
    "dayOfMonth": 27,
    "hour": 20,
    "minute": 36,
    "second": 2,
    "month": "FEBRUARY",
    "dayOfWeek": "MONDAY",
    "dayOfYear": 58
  },
  "requestToBeForgotten": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "transitions": [],
        "transitionRules": [],
        "fixedOffset": true
      }
    },
    "nano": 0,
    "year": 2023,
    "monthValue": 2,
    "dayOfMonth": 28,
    "hour": 22,
    "minute": 38,
    "second": 6,
    "month": "FEBRUARY",
    "dayOfWeek": "TUESDAY",
    "dayOfYear": 59
  }
}