Cancel Order
Cancel an ITAD order within 2 hours of placement.
POST
/api/v1/itad/{order_number}/cancelDescription
Cancels an ITAD order by order_number. No request body is required.
Cancellation is allowed within 2 hours of placement (UTC), measured by elapsed seconds. For example, an order placed at 10:15 UTC can be cancelled until 12:15 UTC.
The time window uses the unix timestamp embedded in order_number when available (Place Order format); otherwise created_at (UTC) is used.
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <access_token> | Yes |
| Content-Type | application/json | Yes |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| order_number | string | Yes | Numeric order number returned by Place Order or the ITAD order list/detail endpoints. |
Response
| Field | Type | Description |
|---|---|---|
| message | string | Cancellation result message. |
| order_number | string | Cancelled order number. |
Notes
- No request body; Content-Type is optional.
- Errors use the same envelope as Place Order: success, message, and errors.cancelOrder (string array) for business-rule failures.
- Cancellation is allowed from any non-cancelled status as long as the order is still within the 2-hour window — not only immediately after placement.
- Cancel sets order_status to CANCELLED; it does not reverse recovery actions already started (labels, pickup requests, box shipment).
- Use order_number from Place Order, Order List, or Order Detail. order_id is not accepted on this route.
Related Endpoints
Did this page help you?
Request
curl -X POST https://dev-api.unduit.com/api/v1/itad/174894512345/cancel \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"Success Response
{
"message": "Order has been cancelled successfully",
"order_number": "174894512345"
}Error Responses
401 Unauthorized
{
"success": false,
"message": "Unauthorized"
}400 Already Cancelled
{
"success": false,
"message": "Order is already cancelled",
"errors": {
"cancelOrder": ["Order is already cancelled"]
}
}422 Invalid Order Number
{
"success": false,
"message": "Invalid order number",
"errors": {
"cancelOrder": ["A valid order number is required."]
}
}404 Not Found
{
"success": false,
"message": "Order not found",
"errors": {
"cancelOrder": ["Order not found"]
}
}403 Time Limit Exceeded
{
"success": false,
"message": "Time limit has been exceeded",
"errors": {
"cancelOrder": ["Time limit has been exceeded"]
}
}