Cancel order
Requests cancellation of an order. A 201 response means the cancellation request was received — not necessarily that the order is cancelled yet.
Check the cancellationStatus in the response:
- orders that can be cancelled immediately (for example, those not yet dispatched) come back
canceledright away - others come back
pendingand are reviewed asynchronously before being approved or denied
For requests that return pending, listen for the order.cancellationrequest.created and order.cancellationrequest.updated events to learn the outcome — see Order Cancellation Requests events.
Authorizations
API token from the SIBI developer dashboard (developer.sibipro.com), sent as Authorization: Bearer <token>.
Path Parameters
The ID of the order to cancel
Body
Reason for the cancellation
"Customer requested a cancellation"
Response
Cancellation requested. The response reflects the current cancellationStatus: usually pending (queued for asynchronous review), but already canceled for orders that are cancelled immediately.
Timestamp when the cancellation was requested
"2024-01-20T12:00:00Z"
Status of the cancellation request. pending: the request is awaiting review. approved or canceled: the order has been cancelled. denied: the request was rejected and the order continues processing.
approved, denied, pending, canceled "pending"
Reason for the cancellation request
"Customer requested a cancellation"