Skip to main content
POST
Cancel order

Authorizations

Authorization
string
header
required

API token from the SIBI developer dashboard (developer.sibipro.com), sent as Authorization: Bearer <token>.

Path Parameters

id
string
required

The ID of the order to cancel

Body

application/json
reason
string
required

Reason for the cancellation

Example:

"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.

requestedAt
string<date-time>
required

Timestamp when the cancellation was requested

Example:

"2024-01-20T12:00:00Z"

cancellationStatus
enum<string>

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.

Available options:
approved,
denied,
pending,
canceled
Example:

"pending"

cancellationReason
string

Reason for the cancellation request

Example:

"Customer requested a cancellation"