POST Update Task
Introduction
Updates an existing yard task's details including assigned users, locations, priorities, and associated receipts or loads. Allows modification of task assignments, descriptions, notes, and entry ticket information. This API is used when task requirements change, reassigning tasks to different users or locations, or updating task priorities based on operational needs.
API Request
POST /{taskId}/update
Body Request Parameters
{
"assignUserName": "string",
"assignLocationId": "string",
"customerId": "string",
"receiptIds": [
"string"
],
"loadIds": [
"string"
],
"assigneeUserId": "string",
"description": "string",
"entryId": "string",
"priority": "string",
"note": "string",
"lastStepAssignedUserIds": [
"string"
],
"planedLastStepAssignedUserIds": [
"string"
],
"lastStepAssignedUserNames": [
"string"
],
"planedLastStepAssignedUserNames": [
"string"
],
"lastStepId": "string",
"planedAssignAllSteps": true,
"entryTicketView": {
"id": 12345,
"entryId": "ET12345",
"carrierId": "CAR12345",
"companyId": "COMP12345",
"driverId": "DRV12345",
"vehicleId": "VEH12345",
"checkInComboId": "COMBO123",
"checkOutComboId": "COMBO456",
"checkInStartTime": "string",
"checkInEndTime": "string",
"checkOutStartTime": "string",
"checkOutEndTime": "string",
"notes": "string",
"entryStatus": "CHECKED_IN",
"rejectReason": "string",
"forceCheckoutReason": "string",
"tags": [
"string"
],
"inYardAction": "LOADING",
"inboundAction": "DROP_OFF",
"outboundAction": "PICK_UP",
"createdSource": "SELF_CHECK_IN",
"createdTime": "string",
"createdBy": "string",
"updatedTime": "string",
"updatedBy": "string",
"customerId": "CUST12345",
"dropOffLocationId": "LOC123",
"dropOffLocationType": "DOCK",
"pickUpLocationId": "LOC456",
"pickUpLocationType": "YARD",
"dropOffLocationName": "North Dock",
"pickUpLocationName": "South Yard",
"carrierView": {
"carrierId": "string",
"carrierName": "string",
"scac": [
"string"
],
"usdot": "string",
"mcNumber": "string",
"verified": true,
"createdTime": "string",
"createdBy": "string",
"updatedTime": "string",
"updatedBy": "string",
"carrierStatus": "ACTIVE,INACTIVE,EXCEPTION",
"knownName": "string",
"orgIds": [
"string"
]
},
"driverView": {
"driverId": "string",
"driverName": "string",
"driverPhone": "string",
"driverLicensePhotos": [
"string"
],
"driverPhotos": [
"string"
],
"lastName": "string",
"firstName": "string",
"middleName": "string",
"licenseNumber": "string",
"email": "string",
"createdTime": "string",
"createdBy": "string",
"updatedTime": "string",
"updatedBy": "string",
"carrierId": "string",
"carrierName": "string",
"usdotNumber": "string",
"badge": "string"
},
"vehicleView": {
"id": 0,
"vehicleId": "string",
"licensePlate": "ABC123",
"platePhoto": "string",
"vehicleType": "TRACTOR",
"usdotNumber": "string",
"mcNumber": "string",
"usdotPhoto": "string",
"truckPhotos": [
"string"
],
"notes": "string",
"createdTime": "string",
"createdBy": "string",
"updatedTime": "string",
"updatedBy": "string",
"carrierId": "string",
"carrierName": "string",
"customerId": "string",
"customerName": "string"
},
"inboundCustomerIds": "[\"CUST001\", \"CUST002\"]",
"inboundReceiptIds": "[\"REC001\", \"REC002\"]",
"inboundPhotoIds": "[\"PHOTO001\", \"PHOTO002\"]",
"outboundCustomerIds": "[\"CUST003\"]",
"outboundPhotoIds": "[\"PHOTO003\"]",
"outboundProofPhotoIds": "[\"PROOF001\"]",
"pickUpEquipmentIds": "[\"EQP001\"]",
"timeLines": [
{
"id": 0,
"entryId": "string",
"action": "GATE_CHECK_IN",
"actionTime": "string",
"actionDetail": {
"taskId": "string",
"assignee": "string",
"note": "string",
"taskSteps": [
null
],
"createdSource": "[",
"customerId": "string",
"customerName": "string",
"inbound": {},
"outbound": {},
"equipmentType": "[",
"equipmentNo": "string",
"dockId": "string",
"dockName": "string",
"rejectReason": "string",
"action": "["
},
"actionBy": "string",
"actionSource": "SYSTEM",
"actionRemark": "string",
"createdTime": "string",
"createdBy": "string",
"updatedTime": "string",
"updatedBy": "string"
}
],
"outboundLoadIds": "[\"LOAD001\"]",
"appointmentId": "APP001",
"taskEquipmentId": "TASK_EQP001",
"loadTaskId": "LOAD_TASK001",
"loadTaskAssignUserName": "Loader A",
"receiveTaskId": "RECEIVE_TASK001",
"receiveTaskAssignUserName": "Receiver B",
"inboundCustomerNames": "[\"Customer A\", \"Customer B\"]",
"outboundCustomerNames": "[\"Customer C\"]",
"dropOffEquipmentId": "DROP_EQP001",
"yardId": "YARD001",
"createShuttleTaskAfterCheckIn": true,
"createShuttleTaskAfterCheckOut": true,
"checkInInfo": {
"badge": "string",
"driverPhone": "string",
"lastName": "string",
"firstName": "string",
"middleName": "string",
"licenseNumber": "string",
"driverName": "string",
"driverId": "string",
"carrierId": "string",
"carrierName": "string",
"usdotNumber": "string",
"vehicleId": "string",
"licensePlate": "string",
"vehicleType": "BOX_TRUCK",
"combinationType": "NO_EQUIPMENT",
"equipmentId": "string",
"equipmentNo": "string",
"sealNumber": "string",
"equipmentType": "VEHICLE",
"locationId": "string",
"suggestLocationId": "string",
"suggestCount": 0,
"driverInfo": {
"driverPhone": "string",
"lastName": "string",
"firstName": "string",
"middleName": "string",
"licenseNumber": "string",
"driverName": "string",
"driverId": "string",
"driverLicensePhotos": [
"string"
],
"driverPhotos": [
"string"
],
"badge": "string"
},
"checkPhotos": [
{
"groupName": "[",
"photos": [
null
]
}
],
"locationName": "string",
"driverConfirmDropOffLocationId": "string",
"driverConfirmDropOffEquipmentNo": "string",
"driverConfirmDropOffEquipmentType": "VEHICLE",
"driverConfirmPickUpLocationId": "string",
"driverConfirmPickUpEquipmentNo": "string",
"driverConfirmPickUpEquipmentType": "VEHICLE"
},
"checkOutInfo": {
"badge": "string",
"driverPhone": "string",
"lastName": "string",
"firstName": "string",
"middleName": "string",
"licenseNumber": "string",
"driverName": "string",
"driverId": "string",
"carrierId": "string",
"carrierName": "string",
"usdotNumber": "string",
"vehicleId": "string",
"licensePlate": "string",
"vehicleType": "BOX_TRUCK",
"combinationType": "NO_EQUIPMENT",
"equipmentId": "string",
"equipmentNo": "string",
"sealNumber": "string",
"equipmentType": "VEHICLE",
"locationId": "string",
"suggestLocationId": "string",
"suggestCount": 0,
"driverInfo": {
"driverPhone": "string",
"lastName": "string",
"firstName": "string",
"middleName": "string",
"licenseNumber": "string",
"driverName": "string",
"driverId": "string",
"driverLicensePhotos": [
"string"
],
"driverPhotos": [
"string"
],
"badge": "string"
},
"checkPhotos": [
{
"groupName": "[",
"photos": [
null
]
}
],
"locationName": "string",
"driverConfirmDropOffLocationId": "string",
"driverConfirmDropOffEquipmentNo": "string",
"driverConfirmDropOffEquipmentType": "VEHICLE",
"driverConfirmPickUpLocationId": "string",
"driverConfirmPickUpEquipmentNo": "string",
"driverConfirmPickUpEquipmentType": "VEHICLE"
},
"preEquipmentInfo": {
"equipmentId": "EQ12345",
"equipmentNo": "CONT12345",
"containerSize": "FORTY",
"trailerSize": "FORTY_EIGHT",
"equipmentType": "CONTAINER",
"cargoStatus": "LOADED",
"isReefer": false,
"equipmentCondition": "GOOD",
"locationId": "string",
"locationName": "string"
},
"pickUpEquipmentInfos": [
{
"equipmentId": "EQ12345",
"equipmentNo": "CONT12345",
"containerSize": "FORTY",
"trailerSize": "FORTY_EIGHT",
"equipmentType": "CONTAINER",
"cargoStatus": "LOADED",
"isReefer": false,
"equipmentCondition": "GOOD",
"locationId": "string",
"locationName": "string"
}
],
"dropOffEquipmentInfo": {
"equipmentId": "EQ12345",
"equipmentNo": "CONT12345",
"containerSize": "FORTY",
"trailerSize": "FORTY_EIGHT",
"equipmentType": "CONTAINER",
"cargoStatus": "LOADED",
"isReefer": false,
"equipmentCondition": "GOOD",
"locationId": "string",
"locationName": "string"
},
"errorInfo": {
"type": "INVALID_DRIVER",
"errorMessage": "Driver information is invalid"
},
"taskAssignee": "string",
"customerName": "string",
"tripNos": [
"string"
],
"receiptListView": [
{
"id": 0,
"receiptId": "string",
"receiptStatus": "string",
"receiptType": "string",
"poNo": "string",
"carrierId": "string",
"customerId": "string",
"referenceNo": "string",
"equipmentType": "string",
"equipmentNo": "string",
"totalPalletQty": 0,
"itemLines": [
{
"itemId": null,
"itemName": null,
"itemQty": null,
"palletQty": null,
"itemSpecDesc": null,
"itemSpecName": null,
"uomId": null,
"qty": null
}
],
"appointmentTime": "string",
"appointmentId": "string",
"sealNo": "string",
"dataChannel": "YMS",
"eventTime": "string",
"extraData": "string",
"carrierName": "string",
"customerName": "string",
"dynamicFieldValues": [
{
"entityId": null,
"entityType": null,
"fieldCode": null,
"value": null,
"fieldName": null,
"longValue": null,
"shortValue": null
}
],
"proNos": [
"string"
],
"invoicePros": [
"string"
],
"doNos": [
"string"
],
"tripNo": "string"
}
],
"loadListView": [
{
"id": "string",
"loadId": "LOAD-12345",
"loadStatus": "string",
"loadNo": "string",
"shipMethod": "string",
"carrierId": "string",
"appointmentTime": "2025-08-08T10:00:00",
"appointmentId": "string",
"orderIds": [
"string"
],
"customerId": "string",
"masterBol": "string",
"sealNo": "123456",
"customerName": "string",
"carrierName": "string",
"orderViews": [
{
"id": null,
"orderId": null,
"orderStatus": null,
"customerId": null,
"poNo": null,
"referenceNo": null,
"retailer": null,
"shipFrom": null,
"shipTo": null,
"totalPalletQty": null,
"totalCartonQty": null,
"itemInfos": null,
"customerName": null,
"carrierName": null,
"shipToAddress": null,
"shipFromAddress": null,
"appointmentTime": null,
"dynamicFieldValues": null,
"proNos": null,
"invoicePros": null,
"doNos": null,
"tripNo": null,
"shippedTime": null
}
],
"dynamicFieldValues": [
{
"entityId": null,
"entityType": null,
"fieldCode": null,
"value": null,
"fieldName": null,
"longValue": null,
"shortValue": null
}
],
"equipmentType": "TRAILER",
"equipmentNo": "string",
"referenceNoList": [
"string"
],
"poNoList": [
"string"
],
"templateLoadKey": "string",
"proNos": [
"string"
],
"invoicePros": [
"string"
],
"doNos": [
"string"
],
"tripNos": [
"string"
],
"loadType": "string",
"stagingLocationName": "string",
"shippedTime": "string"
}
],
"preEntryId": "string",
"driverArrivedTime": "string",
"colorTag": "string",
"inboundSealNo": "string",
"outboundSealNo": "string",
"currentSealNo": "string"
}
}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 |
| body | body | GeneralTaskUpdateCmd | No | none |
Response Example
200 Response
{
"id": 0,
"taskId": "",
"taskType": "",
"timeStatus": "",
"startTime": "",
"lastPauseTime": "",
"endTime": "",
"totalRunTime": 0,
"totalPausedTime": 0,
"createdTime": "",
"updatedTime": "",
"createdBy": "",
"updatedBy": "",
"assignUserName": "",
"plannedLocationId": "",
"assignLocationId": "",
"assignLocationName": "",
"customerId": "",
"customerName": "",
"entryId": "",
"loadIds": [
""
],
"receiptIds": [
""
],
"taskStatus": "",
"assigneeUserId": "",
"description": "",
"priority": "",
"note": "",
"lastStepAssignedUserIds": [
""
],
"planedLastStepAssignedUserIds": [
""
],
"lastStepAssignedUserNames": [
""
],
"planedLastStepAssignedUserNames": [
""
],
"lastStepId": "",
"planedAssignAllSteps": false
}Response
| Status Code | Definition | Description | Data Model |
|---|---|---|---|
| 200 | OK (opens in a new tab) | none | GeneralTaskView |