Skip to main content
POST
/
orders
/
{order_id}
/
cancel
Cancel Order
curl --request POST \
  --url https://api.zinc.com/orders/{order_id}/cancel \
  --header 'Authorization: <api-key>'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}
Cancel an order that is currently being processed. Currently cancellation is only possible while the order is still waiting in the queue to be processed. Once we start an order, we are unable to cancel it.
Orders that have already been started or completed cannot be cancelled.

Authorizations

​
Authorization
string
header
required

Zinc API key (Bearer zn_...)

Headers

​
authorization
string | null

Path Parameters

​
order_id
string<uuid>
required

Response

Successful Response