API Docs
YMS API
Shuttle Task/Level 1
POST Update Shuttle Task

POST Update Shuttle Task

Introduction

Updates an existing shuttle task identified by its task ID. This endpoint allows modification of task details such as equipment assignment, source/destination locations, planned schedule, priority, and notes. Only tasks in NEW or IN_PROGRESS status can be updated. The system validates equipment availability, checks for scheduling conflicts, and manages location status changes automatically - releasing the original target location and reserving the new one when the destination changes. If the task is still in NEW status, a push notification is sent to yard users after the update. Supports force-occupy mode for location conflicts via the forceCreate flag.

API Request

POST /shuttle-task/{taskId}/update

Body Request Parameters

{
  "equipmentType": "VEHICLE",
  "prioritize": true,
  "equipmentId": "string",
  "fromLocationId": "string",
  "toLocationId": "string",
  "plannedStartTime": "string",
  "plannedEndTime": "string",
  "notes": "string",
  "photos": [
    "string"
  ],
  "releaseLocation": false,
  "forceCreate": false
}

Request Parameters

NameLocationTypeRequiredDescription
taskIdpathstringYesnone
bodybodyShuttleTaskUpdateCmdNonone

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 CodeDefinitionDescriptionData Model
200OK (opens in a new tab)noneRShuttleTaskView