Skip to main content
POST
/
{id}
/
cancel
Cancel order
curl --request POST \
  --url https://api.sibipro.com/orders/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Customer requested a cancellation"
}
'
{
  "requestedAt": "2024-01-20T12:00:00Z",
  "cancellationStatus": "pending",
  "cancellationReason": "Customer requested a cancellation"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth 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

Order cancellation request created successfully

​
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

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

"pending"

​
cancellationReason
string

Reason for the cancellation request

Example:

"Customer requested a cancellation"