## Replace Order

`$ clear-street v1:orders replace-order`

**patch** `/v1/accounts/{account_id}/orders/{order_id}`

Replace an order with new parameters

### Parameters

- `--account-id: number`

  Path param: Account identifier

- `--order-id: string`

  Path param: Order identifier

- `--limit-price: optional string`

  Body param: New limit price for the order

- `--quantity: optional string`

  Body param: New quantity for the order

- `--stop-price: optional string`

  Body param: New stop price for the order

- `--time-in-force: optional "DAY" or "GOOD_TILL_CANCEL" or "IMMEDIATE_OR_CANCEL" or 7 more`

  Body param: New time in force for the order

### Returns

- `V1OrderReplaceOrderResponse: BaseResponse`

  - `data: object { id, account_id, client_order_id, 29 more }`

    A trading order with its current state and execution details.

    This is the unified API representation of an order across its lifecycle,
    combining data from execution reports, order status queries, and parent/child tracking.

    - `id: string`

      Engine-assigned unique identifier for this order (UUID).

    - `account_id: number`

      Account placing the order

    - `client_order_id: string`

      Client-provided identifier echoed back (FIX tag 11).

    - `created_at: string`

      Timestamp when order was created (UTC)

    - `filled_quantity: string`

      Cumulative filled quantity

    - `instrument_id: string`

      OEMS instrument UUID for the traded instrument.

    - `instrument_type: "COMMON_STOCK" or "PREFERRED_STOCK" or "OPTION" or 2 more`

      Type of security

      - `"COMMON_STOCK"`

      - `"PREFERRED_STOCK"`

      - `"OPTION"`

      - `"CASH"`

      - `"OTHER"`

    - `leaves_quantity: string`

      Remaining unfilled quantity

    - `order_type: "MARKET" or "LIMIT" or "STOP" or 4 more`

      Type of order (MARKET, LIMIT, etc.)

      - `"MARKET"`

      - `"LIMIT"`

      - `"STOP"`

      - `"STOP_LIMIT"`

      - `"TRAILING_STOP"`

      - `"TRAILING_STOP_LIMIT"`

      - `"OTHER"`

    - `quantity: string`

      Total order quantity

    - `side: "BUY" or "SELL" or "SELL_SHORT" or "OTHER"`

      Side of the order (BUY, SELL, SELL_SHORT)

      - `"BUY"`

      - `"SELL"`

      - `"SELL_SHORT"`

      - `"OTHER"`

    - `status: "PENDING_NEW" or "NEW" or "PARTIALLY_FILLED" or 12 more`

      Current status of the order

      - `"PENDING_NEW"`

      - `"NEW"`

      - `"PARTIALLY_FILLED"`

      - `"FILLED"`

      - `"CANCELED"`

      - `"REJECTED"`

      - `"EXPIRED"`

      - `"PENDING_CANCEL"`

      - `"PENDING_REPLACE"`

      - `"REPLACED"`

      - `"DONE_FOR_DAY"`

      - `"STOPPED"`

      - `"SUSPENDED"`

      - `"CALCULATED"`

      - `"OTHER"`

    - `symbol: string`

      Trading symbol

    - `time_in_force: "DAY" or "GOOD_TILL_CANCEL" or "IMMEDIATE_OR_CANCEL" or 8 more`

      Time in force instruction

      - `"DAY"`

      - `"GOOD_TILL_CANCEL"`

      - `"IMMEDIATE_OR_CANCEL"`

      - `"FILL_OR_KILL"`

      - `"GOOD_TILL_DATE"`

      - `"AT_THE_OPENING"`

      - `"AT_THE_CLOSE"`

      - `"GOOD_TILL_CROSSING"`

      - `"GOOD_THROUGH_CROSSING"`

      - `"AT_CROSSING"`

      - `"OTHER"`

    - `updated_at: string`

      Timestamp of the most recent update (UTC)

    - `venue: string`

      MIC code of the venue where the order is routed

    - `average_fill_price: optional string`

      Average fill price across all executions

    - `details: optional array of string`

      Contains execution, rejection or cancellation details, if any

    - `expires_at: optional string`

      Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.

    - `extended_hours: optional boolean`

      Whether the order is eligible for extended-hours trading.

    - `limit_offset: optional string`

      Limit offset for trailing stop-limit orders (signed)

    - `limit_price: optional string`

      Limit price (for LIMIT and STOP_LIMIT orders)

    - `queue_state: optional "AWAITING_RELEASE" or "RELEASED"`

      Parent order queue state, present when the order is awaiting release or released.

      - `"AWAITING_RELEASE"`

      - `"RELEASED"`

    - `releases_at: optional string`

      Scheduled release time for orders awaiting release.

    - `stop_price: optional string`

      Stop price (for STOP and STOP_LIMIT orders)

    - `trailing_limit_px: optional string`

      Current trailing limit price computed by the trailing strategy

    - `trailing_offset: optional string`

      Trailing offset amount for trailing orders

    - `trailing_offset_type: optional "PRICE" or "BPS"`

      Trailing offset type for trailing orders

      - `"PRICE"`

      - `"BPS"`

    - `trailing_stop_px: optional string`

      Current trailing stop price computed by the trailing strategy

    - `trailing_watermark_px: optional string`

      Trailing watermark price for trailing orders

    - `trailing_watermark_ts: optional string`

      Trailing watermark timestamp for trailing orders

    - `underlying_instrument_id: optional string`

      OEMS instrument ID of the option's underlying instrument. Populated only
      for OPTIONS orders; `null` for non-options and for options whose underlier
      cannot be resolved from the instrument cache.

### Example

```cli
clear-street v1:orders replace-order \
  --api-key 'My API Key' \
  --account-id 0 \
  --order-id order_id
```

#### Response

```json
{
  "data": {
    "account_id": 19816,
    "average_fill_price": "149.95",
    "created_at": "2025-10-31T13:30:00.000000000Z",
    "filled_quantity": "50",
    "id": "my-ref-id-20251001-001",
    "instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8",
    "instrument_type": "COMMON_STOCK",
    "leaves_quantity": "50",
    "limit_price": "150.50",
    "order_type": "LIMIT",
    "quantity": "125",
    "side": "BUY",
    "status": "PENDING_REPLACE",
    "stop_price": null,
    "symbol": "AAPL",
    "time_in_force": "DAY",
    "updated_at": "2025-10-31T14:10:00.000000000Z"
  },
  "error": null,
  "metadata": {
    "request_id": "1d2e3f4a-5b6c-7d8e-9f0a-1b2c3d4e5f6a"
  }
}
```