GET Get Shuttle Task by ID
Introduction
Retrieves detailed information of a specific shuttle task by its unique task ID. Returns comprehensive task data including status, equipment details, location information, assignee, timestamps, and any exceptions or cancellation reasons. Useful for tracking task progress and viewing complete task history.
API Request
GET /shuttle-task/{taskId}
Request Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| taskId | path | string | Yes | none |
| 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 |
Response Example
200 Response
{
"code": 0,
"msg": "",
"success": false,
"data": {
"taskId": "",
"taskStatus": "",
"prioritize": false,
"equipmentType": "",
"equipmentId": "",
"fromLocationId": "",
"toLocationId": "",
"assigneeId": "",
"createdTime": "",
"updatedTime": "",
"plannedStartTime": "",
"plannedEndTime": "",
"taskStartTime": "",
"taskEndTime": "",
"shuttleStartTime": "",
"shuttleEndTime": "",
"shuttleBy": "",
"notes": "",
"photos": [
""
],
"exceptionType": "",
"exceptionReason": "",
"cancelReason": "",
"equipmentBeforeUpdate": {
"equipmentNo": "",
"equipmentId": "",
"equipmentStatus": "",
"equipmentType": "",
"trailerSize": "",
"containerSize": "",
"equipmentCondition": "",
"sealNumber": "",
"locationId": "",
"locationName": ""
},
"equipmentAfterUpdate": {
"equipmentNo": "",
"equipmentId": "",
"equipmentStatus": "",
"equipmentType": "",
"trailerSize": "",
"containerSize": "",
"equipmentCondition": "",
"sealNumber": "",
"locationId": "",
"locationName": ""
},
"fromLocationName": "",
"fromLocationGroupName": "",
"toLocationName": "",
"toLocationGroupName": "",
"equipmentNo": "",
"assigneeUserName": "",
"shuttleByName": "",
"equipmentCondition": "",
"isPinned": false,
"pinnedTime": ""
}
}Response
| Status Code | Definition | Description | Data Model |
|---|---|---|---|
| 200 | OK (opens in a new tab) | none | RShuttleTaskView |