GET
/
orders
/
{order_id}
/
cancellations

Headers

X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer

Path Parameters

order_id
integer
required

Response

200 - application/json

Cancellation record for an order.

order_id
integer

The ID of the order this cancellation relates to.

app_id
integer

The ID of the app that originated this order.

status
enum<string>

Status of the overall cancellation.

Available options:
CANCELED,
PARTIALLY_CANCELED,
CANCELLATION_FAILURE
cancelled_bags
object[]

Bags within the order that were cancelled.

message
string

Description of the outcome of the order cancellation request.

Was this page helpful?

Cancel BagCreate Order