POST
/
{id}
/
cancel
curl --request POST \
  --url https://api.sibipro.com/orders/{id}/cancel \
  --header 'Content-Type: application/json' \
  --data '{
  "reason": "Customer requested a cancellation"
}'
{
  "cancellationStatus": "pending",
  "cancellationReason": "Customer requested a cancellation",
  "requestedAt": "2024-01-20T12:00:00Z"
}

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

201
application/json
Order cancellation request created successfully
​
requestedAt
string
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"