POST Cancel Shuttle Task
Introduction
Cancels an active or pending shuttle task with a specified reason. Optionally updates the equipment's destination location if the equipment has already been moved. This operation is used when a task cannot be completed as planned due to operational changes or exceptions. Returns a boolean indicating cancellation success.
API Request
POST /shuttle-task/{taskId}/cancel
Body Request Parameters
{
"cancelReason": "string",
"toLocation": "string"
}Request Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| taskId | path | string | Yes | task ID |
| X-Tenant-ID | header | string | No | none |
| X-Yard-ID | header | string | No | none |
| Item-Time-Zone | header | string | No | none |
| Authorization | header | string | No | none |
| body | body | ShuttleTaskCancelCmd | No | none |
Response Example
200 Response
{
"code": 0,
"msg": "",
"success": false,
"data": false
}Response
| Status Code | Definition | Description | Data Model |
|---|---|---|---|
| 200 | OK (opens in a new tab) | none | RBoolean |