Cancel Order (Convenience Endpoint)

PATCH

/orders/{id}/cancel

Cancel an order using a convenience endpoint.
This is equivalent to updating the order status to 'cancelled' but provides a more semantic API.
Orders can only be cancelled if they are in 'pending' or 'paid' status.

Request

Path Params

Responses

🟢200OK

application/json

Order cancelled successfully

Body

🟠400Bad Request

🟠404Record Not Found

🟠422Parameter Error

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/orders/ORD-1705312200000-001/cancel'

Response Example

200 - Success

{
    "success": true,
    "data": {
        "id": "ORD-1705312200000-001",
        "customerName": "John Doe",
        "customerEmail": "john@example.com",
        "status": "cancelled",
        "items": [
            {
                "id": "item-1",
                "orderId": "ORD-1705312200000-001",
                "name": "Burger",
                "quantity": 1,
                "price": 8.99,
                "subtotal": 8.99
            }
        ],
        "total": 8.99,
        "createdAt": "2024-01-15T10:30:00.000Z",
        "updatedAt": "2024-01-15T10:32:00.000Z"
    }
}

Modified at 2025-09-17 13:22:25

Delete Order

OrderStatus