Skip to main content
POST
Cancel an order

Authorizations

Authorization
string
header
required

Bearer token used for protected REST API requests.

Path Parameters

orderID
string
required

System order identifier returned by the order service.

Response

Order cancellation result.

Order cancellation response.

isSuccess
boolean
required

Whether service.orderapi accepted and submitted the cancel request.

detail
string
required

Result message. Normal order success is usually "Order cancelled successfully"; stop/bracket order branches return their own success message.

data
string
required

For a normal order, this is the cancelled system order id and usually matches the orderID path parameter. If orderID starts with STOP- or BRACKET-, the controller routes to the stop/bracket handler and data is a serialized JSON string of the cancelled StopOrder or BracketOrder object.

Example:

"ORDER-V1StGXR8_Z5jdHi6B-myT"