---
title: "Get an order details"
method: GET
path: "/v1/orders/{orderId}"
tags: ["Retrieve Order (Synchronous API)"]
---

# Get an order details

`GET /v1/orders/{orderId}`

Retrieves the details of an order.

## Path parameters

- `orderId` string, required

## Response `200`

Successful response.

- GetOrderResponse
  - `id` string — The identifier of the order.
  - `totalItemsInCart` integer — Total items in the cart.
  - `testOrder` boolean — The order is a test order or not.
  - `sendEmail` boolean — Send email notification to the customer or not.
  - `locale` string — The locale of the order.
  - `currency` string — The currency of the order.
  - `taxExempt` boolean — Tax exempted or not of the order.
  - `shopperLoginType` string — 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.
  - `shopperId` string — The identifier of the shopper.
  - `softDescriptor` string — 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.
  - `orderState` string — Specifies the current state of the order. The possible values are as follows. Open, In Process, Cancelled, or Submitted.
  - `lineItems` object[]
    - `id` string — The identifier of the line item.
    - `quantity` integer — The quantity of the line item.
    - `lineItemState` string — The current status of the line item.
    - `product` object
      - `id` string — The identifier of the product.
      - `sku` string — The SKU of the product.
      - `displayName` string — The display name of the product.
      - `systemProductName` string — The system product name of the product.
    - `pricing` object
      - `netPrice` object — The price paid for the line item. - It includes: * The "Included in Price" fee (an invisible fee) if it's configured for the line item. * The discount - It does not include: * The "Excluded from price" fee (a visible fee) * The tax.
        - `value` number, double
      - `listPrice` object — The per-unit price setup in the price list for the product associated with this line item. - It includes: * The "Included in Price" fee (an invisible fee) if it's configured for the line item. * If the price list is set to tax inclusive, this price will include tax. - It does not include: * The discount * The "Excluded from price" fee (a visible fee) * If price list is set to tax exclusive, this price will NOT include tax.
        - `value` number, double
      - `salePriceWithQuantity` object — The total calculated price for the line item with quantity. - It includes: * The line item level discount * The "Included in Price" fee (an invisible fee) if it's configured for the line item * If the price list is set to tax inclusive, this price will include tax. - It does not include: * The order level discount * The "Excluded from price" fee (a visible fee) * If price list is set to tax exclusive, this price will NOT include tax.
        - `value` number, double
      - `totalDiscountWithQuantity` object — The total discount of the line item with quantity. It does not include the order level discount.
        - `value` number, double
      - `importTax` object — VAT or other sales tax assessed on the transaction.
        - `value` number, double
      - `importDuty` object — When a customer purchases products online, one or more of the products may not originate in the country the customer resides in, and therefore are subject to a customs duty when importing transported across international borders. When goods are not shipped domestically (within the customer’s country) or within a single customs union, such as the European Union, the customer is liable to pay any inbound duties which the customer’s local customs authority deems appropriate.
        - `value` number, double
    - `subscriptions` object[]
      - `id` string — The identifier for the subscription.
      - `expirationDate` string, date-time — The expiration date for the subscription.
    - `downloads` object[]
      - `downloadUri` string — Download URL.
    - `digitalRights` object[]
      - `unlockCode` string — Unlock Code.
  - `pricing` object
    - `total` object — The final price of the order.
      - `value` number, double
    - `subTotal` object — Order total before applying the order level discount. - It includes: * The line item level discount * The "Included in Price" fee (an invisible fee) if it's configured for the line item. * The "Excluded from price" fee (a visible fee) * If the price list is set to tax inclusive, this price will include tax. - It does not include: * The order level discount * If price list is set to tax exclusive, this price will NOT include tax. - The value for this field is the sum of all line item level salePriceWithQuantity values. If there is an "Excluded from price" (a visible fee), it will be treated as a line item and included in this value.
      - `value` number, double
    - `subtotalWithDiscount` object — Subtotal applied order level discount. * If the price list is set to tax inclusive, this price will include tax. * If price list is set to tax exclusive, this price will NOT include tax. * The value for this field uses the following formula: subtotal − discount
      - `value` number, double
    - `shippingAndHandling` object — The shipping and handling fee. - If the price list is set to tax inclusive, this price will include tax. - If price list is set to tax exclusive, this price will NOT include tax.
      - `value` number, double
    - `discount` object — Order level discount. This is calculated based on sum of line item level salePriceWithQuantity. - It includes: * If the price list is set to tax inclusive, this price will include tax - It does not include: * line item level discount. * If price list is set to tax exclusive, this price will NOT include tax - If you need an overall discount for this order, you would need to sum the values for totalDiscountWithQuantity and discount.
      - `value` number, double
    - `tax` object — The sum of all tax of this order.
      - `value` number, double
    - `importTaxAndDuty` object — The sum of import taxes and duties for all line items.
      - `value` number, double
    - `fees` object — The sum of fees for all line items.
      - `value` number, double
  - `businessEntityCode` string — The business entity code of the order
  - `paymentMethods` object[]
    - `type` string — The type of the payment. The payment type will correspond to another element in the source response that contains detailed information specific to the type. For example, a type of creditCard indicates that there is an object in the response named creditCard that will contain card-specific data.
    - `sourceId` string — A unique identifier for the payment source.
    - `sourceClientSecret` string — The unique client secret for the payment source.
    - `creditCard` object — Credit card information. This field is displayed when type is creditCard.
      - `expirationYear` string — Four digits representing the expiration year.
      - `lastFourDigits` string — The last four digits of the card number. (e.g. 1111)
      - `clientSecret` string — The unique client secret for the payment source.
      - `expirationMonth` string — One to two digits representing the expiration month.
      - `brand` string — The card brand (e.g. Visa, MasterCard, American Express, etc.).
      - `flow` string — The flow of the payment.
      - `reusable` boolean — Whether the payment is reusable.
    - `amountContributed` object — The amount which is contributed by this payment source.
      - `currency` string — Three-letter ISO currency code associated with the object.
      - `value` number, double — Value associated with the object.
  - `shippingMethod` object — The shipping method of the order.
    - `code` object — Code
    - `description` object — Description
  - `billingAddress` object — The customer's billing address.
    - `title` string — The customer's title. (Optional, usually for France locale.)
    - `firstName` string — The customer's first name.
    - `lastName` string — The customer's last name.
    - `line1` string — The first line of the address.
    - `line2` string — The second line of the address.
    - `city` string — City or town.
    - `postalCode` string — ZIP or postal code.
    - `country` string — Two-letter country code.
    - `countryName` string — Country Name.
    - `phoneNumber` string — The customer's phone number.
    - `emailAddress` string — The customer's email address.
    - `companyName` string — Company Name.
    - `countrySubdivision` string — State/County/Province/Region.
    - `countyName` string — County Name.
    - `phoneticFirstName` string — The customer's Japanese Katakana first name. (Optional, usually for Japanese locale.)
    - `phoneticLastName` string — The customer's Japanese Katakana last name. (Optional, usually for Japanese locale.)
    - `division` string — The customer's company departmant name. (Optional, usually for Japanese locale.)
  - `shippingAddress` object — The customer's shipping address.
    - `title` string — The customer's title. (Optional, usually for France locale.)
    - `firstName` string — The customer's first name.
    - `lastName` string — The customer's last name.
    - `line1` string — The first line of the address.
    - `line2` string — The second line of the address.
    - `city` string — City or town.
    - `postalCode` string — ZIP or postal code.
    - `country` string — Two-letter country code.
    - `countryName` string — Country Name.
    - `phoneNumber` string — The customer's phone number.
    - `emailAddress` string — The customer's email address.
    - `companyName` string — Company Name.
    - `countrySubdivision` string — State/County/Province/Region.
    - `countyName` string — County Name.
    - `phoneticFirstName` string — The customer's Japanese Katakana first name. (Optional, usually for Japanese locale.)
    - `phoneticLastName` string — The customer's Japanese Katakana last name. (Optional, usually for Japanese locale.)
    - `division` string — The customer's company departmant name. (Optional, usually for Japanese locale.)
  - `taxRegistrations` object[]
    - `key` string — Tax Registration Key.
    - `value` string — Tax ID value.
  - `taxInclusive` boolean — 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.
  - `submissionDate` string, date-time — The date when the order was placed.
  - `requestToBeForgotten` string, date-time — This data is only presented when a request for the removal of personal identifiable information has been made previously.

## Other responses

- `400` — * Bad request.
- `401` — * Please verify your API key and secret (if applicable) is correct.
- `404` — * Order was not found or not transferred or in open state.

---

[API](https://skmtc.net/digitalriver/apis/commerce-api-suite-admin-apis.md) · [All operations](https://skmtc.net/digitalriver/apis/commerce-api-suite-admin-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/digitalriver/commerce-api-suite-admin-apis/revisions/a6efafc1669c/schema)