Orders

Cancel Order

Cancel an order by orderId. Orders can only be canceled if they are in the 'Created' status. If order fulfillment has begun and the order no longer carries the 'Created' status, this request will be rejected.

put/v1/orders/{orderId}/cancel

Request

  • Base URL: https://api.roastify.app
  • URL: https://api.roastify.app/v1/orders/{orderId}/cancel
  • Auth: API key in header x-api-key

Path parameters

orderIdstring required

The Id of the order

Example:1ef87e47-266e-466f-ab06-a64994aefbb0

Response

Order canceled successfully

messagestring required

Example response

{
  "message": "Order canceled successfully"
}

Changes

No recorded changes to this operation across all 1 revision of this API.