---
title: "Retrieve Order"
method: GET
path: "/orders/{orderID}"
tags: ["Orders"]
---

# Retrieve Order

`GET /orders/{orderID}`

Retrieves an Order details by orderID.

## Path parameters

- `orderID` string, required — A unique DriveWealth order identifier created when an order is placed.

## Response `200`

Fetching Order status was successful.

- OrderStatusResponse — Order details for a fixed income asset trade
  - `id` string — A unique DriveWealth order identifier created when an order is placed.
  - `orderNo` string — A unique, human-readable DriveWealth order number.
  - `type` 'MARKET' | 'LIMIT' | 'STOP' | 'STOP_LIMIT' | 'MARKET_IF_TOUCHED' — The type of the Order.
  - `side` 'BUY' | 'SELL' — The side of the order.
  - `status` 'NEW' | 'FILLED' | 'PARTIAL_FILL' | 'REJECTED' | 'CANCELED' | 'PENDING_CANCEL' — The current status of the order.
  - `instrumentID` string, uuid — A unique ID created by DriveWealth to identify a specific instrument.
  - `ISIN` string — An `International Securities Identification Number` (ISIN) uniquely identifies a security. Its structure is defined in ISO 6166. ISINs are commonly used when an Instrument does not have a `symbol`, such as Debt Instruments and Global Mutual Funds.
  - `CUSIP` string — CUSIP stands for `Committee on Uniform Securities Identification Procedures`. A CUSIP number identifies most financial instruments, including: stocks of all registered U.S. and Canadian companies, commercial paper, and U.S. government and municipal bonds. The CUSIP system facilitates the clearance and settlement process of securities. CUSIP numbers consist of nine characters (including letters and numbers) that uniquely identify a company or issuer and the type of financial instrument. A similar system is used to identify foreign securities (`CUSIP International Numbering System or CINS`). CINS employs the same nine character identifier as CUSIP, but also contains a letter in the first position to signify the issuer's country or geographic region.
  - `symbol` string, nullable — The ticker symbol of the Instrument. Debt Instruments and Global Mutual Funds do not have symbols and are referred to buy their `instrumentID` or `ISIN`.
  - `averagePrice` number — The average price of the security being transacted in the order.
  - `currency` 'USD' — The name of the currency in abbreviation form.
  - `totalOrderAmount` number, double — Total amount paid for the order.
  - `cumulativeQuantity` number — The amount of shares currently being transacted; larger orders may execute in chunks.
  - `quantity` number — The amount of the instrument in shares.
  - `fees` number, double — Cost of the order.
  - `ptpWithholdingFee` number, double — The publicly traded partnership (PTP) withholding fee for the order.
  - `createdBy` string — userID of the individual creating the order.
  - `userID` string — userID of the account holder the order relates to.
  - `accountID` string — accountID for the account the order relates to.
  - `accountNo` string — accountNo for the account the order related to.
  - `created` string — The time at which the order was created.
  - `statusMessage` object — If the Order was unsuccessful, this object will be present with additional details regarding why.
    - `errorCode` object — A DriveWealth error code.
    - `message` string — Description of the error code.
    - `reason` string — A longer reason for the error.
  - `amountCash` number, double — The USD-denominated amount to purchase or sell.
  - `OrderExpires` string — The date of expiration for a good-til-canceled order, in “YYYY-MM-DD” format. The order will be canceled if not executed by the market close on this date. If not set, a good-til-canceled Stop and MIT order will be assumed to expire 90 days after creation. If not set, a limit order will be considered GTD and will cancel at the end of the trading day.
  - `salesCredit` SalesCredit — If set, the unit price will be marked up or marked down based on the prescribed amount. Only applicable to Orders for Debt Instruments.
    - `currency` 'USD' — The name of the currency in abbreviation form.
    - `amount` integer — The sales credit amount in cents.
  - `instrumentType` 'EQUITY' | 'ALTERNATIVE_ASSET' | 'MUTUAL_FUND' | 'DEBT' | 'OPTION' | 'CRYPTO' — The classification of the instrument.
  - `dccs` boolean — True, when the Mutual Fund HSA is classified as Defined Contribution Clearing and Settlement (DCC&S) order.
  - `openQuantity` number — The number of units currently represented by the position in the Account.
  - `availableForTradingQuantity` number — The number of units that can currently be traded by the Account holder.
  - `travelRuleBankAccountID` string — Displays travel rule bank account ID which set while creating order
  - `clientOrderTransactionTime` string — The date with a valid timestamp of when a partner received the order from the customer.
  - `clientOrderID` string — A unique identifier that represents the order, as defined by the partner. This detail will be reported to the CAT system for US brokers to more easily reconcile reported information.
  - `executionInstructions` string[] — A list of execution instructions for an order. Currently only supported for Fixed Income orders.

---

[API](https://skmtc.net/drivewealth/apis/authentication-apis.md) · [All operations](https://skmtc.net/drivewealth/apis/authentication-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/drivewealth/authentication-apis/revisions/9fced6d0ac41/schema)
