Cancel Order or order items

POST

/v1/orders/{orderId}/cancel

The POST orders/{orderId}/cancel endpoint can be used to cancel an order or order items in your order.

If you wish to cancel an entire order, you'll need to leave the orderItemIds array empty in the body of the request.

If you wish to cancel an order item or multiple items, you'll need to include the order item IDs in the orderItemIds array in the body of the request.

Request

Path Params

Body Params application/json

Examples

Responses

🟢200OK

text/plain

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.dev.ordermesh.io/v1/orders//cancel' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cancelReason": "Cancel reason string",
    "orderItems": [
        {
            "id": "123456789",
            "quantity": 3
        }
    ],
    "triggerFlow": true
}'

Response Example

200 - Success Example

{
    "message": "Order cancelled successfully"
}

Modified at 2026-02-27 22:33:53

Update an item within an order.

Change the order status to Customer Care Hold