---
title: "Get an order by ID"
method: GET
path: "/orders/{order_id}"
tags: ["Orders"]
---

# Get an order by ID

`GET /orders/{order_id}`

Returns the order specified by its ID.

## Response `200`

OK

- object
  - `id` string, uuid, required
  - `created_at` string, date-time, required — Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
  - `updated_at` string, date-time, required — Date and time when the resource was last updated. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
  - `user_id` string, uuid — The ID of the user. Either user ID or business ID must be specified.
  - `business_id` string, uuid — The ID of the business. Either user ID or business ID must be specified.
  - `account_id` string, uuid, required — The ID of the account that owns the order
  - `cash_amount` string, required — Cash amount for a nominal order, not required if a share quantity is specified.
  - `currency` 'EUR' | 'GBP' | 'USD', required — The currency for the order.
  - `side` 'BUY' | 'SELL', required — Side of the order. * BUY - * SELL -
  - `instrument_id` string, required — International securities identification number defined by [ISO 6166](https://en.wikipedia.org/wiki/International_Securities_Identification_Number).
  - `instrument_id_type` 'ISIN', required — The type of the ID used in the request. * ISIN -
  - `order_type` 'MARKET' | 'LIMIT' | 'STOP', required — Type of the order. * MARKET - * LIMIT - * STOP -
  - `quantity` string, required — Quantity of securities for the order. Only required if the cash amount is not specified.
  - `user_instrument_fit_acknowledgement` boolean — Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade.
  - `limit_price` string — The limit price for orders of the type 'limit'.
  - `stop_price` string — The stop price for orders of the type 'stop'.
  - `expiry_date` string — The order expiration date (last day the order can trade) in the YYYY-MM-DD format. The expiry date can only be set for LIMIT and STOP orders. [RFC 3339, section 5.6](https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339) RFC 3339. The default value is order creation date + 359 days
  - `status` 'NEW' | 'PROCESSING' | 'FILLED' | 'CANCELLED', required — The execution status of the order. * NEW - * PROCESSING - * FILLED - * CANCELLED -
  - `fee` string, required
  - `cancellation_reason` 'CANCELLED_BY_CLIENT' | 'CANCELLED_BY_UPVEST_OPERATIONS' | 'CANCELLED_BY_TRADING_PARTNER' | 'CANCELLED_BY_UPVEST_PLATFORM' — Reason for Order cancellation. The field is present in case the Order has a status of CANCELLED. * CANCELLED_BY_CLIENT - * CANCELLED_BY_UPVEST_OPERATIONS - * CANCELLED_BY_TRADING_PARTNER - * CANCELLED_BY_UPVEST_PLATFORM -
  - `initiation_flow` 'API' | 'PORTFOLIO' | 'CASH_DIVIDEND_REINVESTMENT' | 'PORTFOLIO_REBALANCING' | 'SELL_TO_COVER_FEES' | 'SELL_TO_COVER_TAXES' | 'ACCOUNT_LIQUIDATION' | 'UPVEST_OPERATIONS' | 'SAVINGS_PLAN' | 'CLIENT_OPERATIONS', required — Initiation flow used during order creation, i.e. what triggered the order. * API - * PORTFOLIO - * CASH_DIVIDEND_REINVESTMENT - * PORTFOLIO_REBALANCING - * SELL_TO_COVER_FEES - * SELL_TO_COVER_TAXES - * ACCOUNT_LIQUIDATION - * UPVEST_OPERATIONS - * SAVINGS_PLAN - * CLIENT_OPERATIONS -
  - `execution_flow` 'STRAIGHT_THROUGH' | 'BLOCK' — Execution flow that the order processing goes through. If no value is specified, the default value is assumed - `STRAIGHT_THROUGH`. * STRAIGHT_THROUGH - * BLOCK -
  - `executions` object[], required — Order executions associated with this order
    - `id` string, uuid, required
    - `cash_amount` string, required
    - `share_quantity` string, required
    - `price` string, required
    - `transaction_time` string, date-time, required
    - `taxes` object[], required
      - `type` 'TOTAL', required — Tax type * TOTAL -
      - `amount` string, required
    - `order_id` string, uuid, required
    - `status` 'FILLED' | 'SETTLED' | 'CANCELLED', required — Execution status of the Execution. * FILLED - * SETTLED - * CANCELLED -
    - `side` 'BUY' | 'SELL', required — Side of the execution. * BUY - * SELL -
    - `currency` 'EUR' | 'GBP' | 'USD', required — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - British Pound * USD - US Dollar
    - `settlement_date` string — Order execution settlement date in the YYYY-MM-DD format. [RFC 3339, section 5.6](https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339) RFC 3339
    - `venue_id` string, uuid, required — The ID of the venue
  - `client_reference` string — Immutable reference to the API flow that initiated the order. For client initiated API flows, this is a client provided ID. For internal initiations, it is set to the ID of the related object.
  - `fee_configuration` union[] — fee configuration
    - union
      - object
        - `type` 'TRANSACTION_FEE_BUY' | 'TRANSACTION_FEE_SELL', required — Fee type * TRANSACTION_FEE_BUY - * TRANSACTION_FEE_SELL -
        - `value_type` string, required — The value type must be “ABSOLUTE”.
        - `charge_method` 'CHARGED_BY_CLIENT' | 'COLLECTED_BY_UPVEST', required — Indicates whether the fee will be charged by client or by other methods. * CHARGED_BY_CLIENT - * COLLECTED_BY_UPVEST -
        - `cash_amount` string, required
        - `currency` 'EUR' | 'GBP' | 'USD', required — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - British Pound * USD - US Dollar
      - object
        - `type` 'TRANSACTION_FEE_BUY' | 'TRANSACTION_FEE_SELL', required — Fee type * TRANSACTION_FEE_BUY - * TRANSACTION_FEE_SELL -
        - `transaction_fee_model_id` string, uuid, required — The ID of the transaction fee model.
  - `decision_maker_id` string — ID of the user behind the decision to place an order. Required only if different from the user_id. (e.g. child account order placed by a guardian)

## Other responses

- `401` — Unauthorized. The caller has not been authenticated.
- `403` — Forbidden. The caller has been authenticated but is not allowed to take the requested action.
- `404` — Not Found. The requested resource could not be found.
- `406` — Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
- `429` — Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
- `500` — Internal Server Error. The service encountered an unexpected error.
- `503` — Service Unavailable. The service handling for this request cannot be reached at this time.
- `504` — Gateway Timeout. The service gateway has reached its internal timeout.

---

[API](https://skmtc.net/upvest/apis/upvest-investment-api.md) · [All operations](https://skmtc.net/upvest/apis/upvest-investment-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/upvest/upvest-investment-api/revisions/2c6bc192bc09/schema)