Sign in
latestOpenAPI 3.0.02026-08-1056429755.6 KB

a6efafc1669c

Retrieve Order (Synchronous API)

Get an order details

Retrieves the details of an order.

get/v1/orders/{orderId}

Path parameters

orderIdstring required

The identifier of the Order.

Response

Successful response.

idstring

The identifier of the order.

totalItemsInCartinteger

Total items in the cart.

testOrderboolean

The order is a test order or not.

sendEmailboolean

Send email notification to the customer or not.

localestring

The locale of the order.

currencystring

The currency of the order.

taxExemptboolean

Tax exempted or not of the order.

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.

shopperIdstring

The identifier of the shopper.

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.

orderStatestring

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

businessEntityCodestring

The business entity code of the order

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

Example response

{
  "id": "1067669580082",
  "totalItemsInCart": 1,
  "locale": "en_US",
  "currency": "USD",
  "shopperLoginType": "Anonymous",
  "shopperId": "42317897435",
  "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
        }
      },
      "subscriptions": [
        {
          "id": "10007820082"
        }
      ],
      "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
    },
    "tax": {
      "value": 22
    }
  },
  "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"
      },
      "amountContributed": {
        "currency": "USD",
        "value": 97
      }
    }
  ],
  "billingAddress": {
    "title": "title",
    "firstName": "firstName",
    "lastName": "lastName",
    "line1": "line1",
    "line2": "line2",
    "city": "city",
    "postalCode": "00187",
    "country": "IT",
    "countryName": "Italy",
    "phoneNumber": "06 6780691",
    "emailAddress": "shopxTest@digitalriver.com",
    "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": "shopxTest@digitalriver.com",
    "companyName": "companyName",
    "countrySubdivision": "countrySubdivision",
    "countyName": "countyName",
    "phoneticFirstName": "phoneticFirstName",
    "phoneticLastName": "phoneticLastName",
    "division": "division"
  },
  "taxRegistrations": [
    {
      "key": "IT_VAT2",
      "value": "IT12345678901"
    }
  ]
}