POST
/
orders
/
{id}
/
cancel
curl --request POST \
  --url https://api.cnaught.com/v1/orders/{id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "id": "Gre28Fc35bt3",
  "order_number": "47726-53238-46633-33562-7433",
  "created_on": "2022-08-01T18:00:00.000000Z",
  "metadata": "Customer metadata",
  "description": "On behalf of Jane Smith",
  "amount_kg": 10.5,
  "state": "cancelled",
  "price_usd_cents": 2350,
  "certificate_public_url": null,
  "certificate_download_public_url": null
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Subaccount-Id
string

If present, scopes the operation to the subaccount with given id. See Subaccounts for more info.

​
Idempotency-Key
string

If present, a unique identifier that allows you to retry a request multiple times while only performing the action once. See Idempotency for more info.

Path Parameters

​
id
string
required

ID of order to cancel

Examples:

"Gre28Fc35bt3"

Response

200
application/json

Order Details

The response is of type object.