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

# Update Order

`PATCH /orders/{orderID}`

## Request

- Base URL: `https://bo-api.drivewealth.io/back-office`
- URL: `https://bo-api.drivewealth.io/back-office/orders/{orderID}`
- Auth: HTTP bearer

Updates an Order by orderID.

## Path parameters

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

## Request body

- CancelOrder
  - `method` 'CANCEL', required: The method in which is requested.
  - `traderID` string: The trader ID of the individual.
  - `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.
  - `cancelDetails` CancelDetails: Additional details to clarify when and how the cancel request was received. US broker-dealers must utilize this field for CAT compliance.
    - `initiator` 'C' | 'F', nullable: The individual responsible for initiating the cancellation of an order. Please refer to CAT documentation and instructions for more information on the allowed values.
    - `requestedTimestamp` string, nullable: The requested timestamp in ISO format by user to cancel an order
    - `manualCancel` boolean, nullable: Whether an order cancellation request was received from a human, manually. A false value represents that an automated system initiated the cancel.
    - `comment` string, nullable: A freeform comment to attach to the cancel request

## Response `200`

The Order was Successfully Updated.

- CancelOrderResponse
  - `orderId` string: A unique identifier for the order.
  - `orderNo` string: A human readable order identifier.

---

[API](https://skmtc.dev/drivewealth/apis/core-apis.md) - [All operations](https://skmtc.dev/drivewealth/apis/core-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/drivewealth/apis/core-apis/revisions/daf4a0d7b01a?raw)