Skip to main content
curl -X POST 'https://order.api.e-cross.tech/ext/orders/ACME-ECOM-TEST-003/cancel' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "cancelDate": "2025-01-05T20:00:00Z",
    "cancelReason": "Missing inventory to fulfill the order"
  }'
{
  "orderId": "ACME-ECOM-TEST-003",
  "status": "CANCELLED",
  "cancelDate": "2025-01-05T20:00:00Z",
  "statusHistory": [
    {
      "eventData": {
        "cancelReason": "Missing inventory to fulfill the order"
      },
      "receivedDate": "2025-01-05T20:01:00Z",
      "eventDate": "2025-01-05T20:00:00Z",
      "status": "CANCELLED"
    }
  ]
}

Path Parameters

orderId
string
required
The e-CROSS order ID of the order to cancel.

Request Parameters

cancelDate
string
required
The date and time of the cancellation event, in ISO 8601 format (e.g., 2025-01-05T20:00:00Z).
cancelReason
string
Human-readable reason for the cancellation. Examples:
  • “Missing inventory to fulfill the order”
  • “Customer requested cancellation”
  • “Product discontinued”

Response Fields

The response returns the complete order object with updated status. Refer to the Get order by ID endpoint for the response fields.