Skip to main content
DELETE
Cancel an order

Authorizations

X-API-KEY
string
header
required

Per-user API key. Create and revoke keys from your SOAR account settings. A revoked key stops working within 60 seconds.

Path Parameters

order_id
string
required

Decimal order_id as returned by POST /orders.

Pattern: ^[0-9]{1,20}$

Response

The engine applied the cancel.

order
object
required
reduced_by
integer
required

What the engine actually removed from the book — less than the order's last-known remaining size when a fill landed between your read and the cancel applying, and 0 on an idempotent duplicate. order.filled_qty comes from the projection and may lag, so treat it as a floor and poll GET /orders/{order_id} for the true count.

Required range: x >= 0