...
On a successful request the order will be flagged for deletion, and an HTTP 200 code will be returned with a the last known state of the order. This will match the structure returned by Fetch a Single Order.
A JSON object representing the requested order
Property | Description |
orderNumber | string The identifier for the order |
trayNumber | string The tray number the order is attached to |
poNumber | string Job reference (PO NUM field) |
message | string Any additional details associated with the cancellation. This will typically be empty, though it may include non-blocking warnings (such as noting that the provided deleteReason was ignored because your system is configured to not use them). |
Error
If the order is not found, an HTTP 404 code will be returned with an error
...
| Code Block | ||
|---|---|---|
| ||
{
"error": "Delete reason code does not exist",
"details": [
"Provided: 9999"
]
} |
If the order has been through a station that prevents it from being cancelled, an HTTP 400 code will be returned with an error
| Code Block | ||
|---|---|---|
| ||
{
"error": "Order has been through a non-cancel station",
"details": []
} |