POST Create Shuttle Task

Introduction

Creates a new shuttle task to move equipment (containers or trailers) from one location to another within the yard. This API supports task prioritization, assignee specification, and planned time scheduling. Use the forceCreate flag to override location conflicts, and releaseLocation to automatically free up the destination location if occupied.

API Request

POST /shuttle-task/create

Body Request Parameters

{
  "equipmentType": "VEHICLE",
  "prioritize": true,
  "equipmentId": "string",
  "fromLocationId": "string",
  "toLocationId": "string",
  "assigneeId": "string",
  "plannedStartTime": "string",
  "plannedEndTime": "string",
  "notes": "string",
  "releaseLocation": false,
  "forceCreate": false,
  "entryId": "string"
}

Request Parameters

Name	Location	Type	Required	Description
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	ShuttleTaskCreateCmd	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

POST Search Entry Tickets with Paging POST Update Shuttle Task