Entry Ticket Update Cmd – item Help Center

EntryTicketUpdateCmd

{
  "entryId": "string",
  "carrierId": "string",
  "companyId": "string",
  "driverId": "string",
  "vehicleId": "string",
  "notes": "string",
  "inboundAction": "LIVE_DELIVERY",
  "inboundCustomerIds": [
    "string"
  ],
  "inboundReceiptIds": [
    "string"
  ],
  "inboundPhotoIds": [
    "string"
  ],
  "outboundAction": "LIVE_LOAD",
  "outboundCustomerIds": [
    "string"
  ],
  "outboundPhotoIds": [
    "string"
  ],
  "pickUpEquipmentIds": [
    "string"
  ],
  "inYardAction": "DROP_OFF_RECEIVING",
  "dropOffLocationId": "string",
  "pickUpLocationId": "string",
  "dropOffEquipmentId": "string",
  "outboundLoadIds": [
    "string"
  ],
  "draft": true,
  "appointmentId": "string",
  "checkInComboId": "string",
  "outboundProofPhotoIds": [
    "string"
  ],
  "taskEquipmentId": "string",
  "loadTaskId": "string",
  "receiveTaskId": "string",
  "tags": [
    "string"
  ],
  "checkInInfo": {
    "driverPhone": "string",
    "lastName": "string",
    "firstName": "string",
    "middleName": "string",
    "licenseNumber": "string",
    "licenseType": "LICENSE",
    "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",
    "locationName": "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": "VEHICLE",
        "photos": [
          "string"
        ]
      }
    ],
    "badge": "string",
    "customerId": "string",
    "wmsSuggestedLocationNames": [
      "string"
    ],
    "driverConfirmDropOffLocationId": "string",
    "driverConfirmDropOffEquipmentNo": "string",
    "driverConfirmDropOffEquipmentType": "VEHICLE",
    "driverConfirmPickUpLocationId": "string",
    "driverConfirmPickUpEquipmentNo": "string",
    "driverConfirmPickUpEquipmentType": "VEHICLE"
  },
  "checkOutInfo": {
    "driverPhone": "string",
    "lastName": "string",
    "firstName": "string",
    "middleName": "string",
    "licenseNumber": "string",
    "licenseType": "LICENSE",
    "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",
    "locationName": "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": "VEHICLE",
        "photos": [
          "string"
        ]
      }
    ],
    "badge": "string",
    "customerId": "string",
    "wmsSuggestedLocationNames": [
      "string"
    ],
    "driverConfirmDropOffLocationId": "string",
    "driverConfirmDropOffEquipmentNo": "string",
    "driverConfirmDropOffEquipmentType": "VEHICLE",
    "driverConfirmPickUpLocationId": "string",
    "driverConfirmPickUpEquipmentNo": "string",
    "driverConfirmPickUpEquipmentType": "VEHICLE"
  },
  "createShuttleTaskAfterCheckIn": true,
  "createShuttleTaskAfterCheckOut": true,
  "forceCheckoutReason": "string",
  "customerId": "string",
  "entryStatus": "NEW",
  "driverArrivedTime": "string",
  "colorTag": "string"
}

Properties

Name	Type	Required	Constraints	Description
entryId	string	true	none	Entry ticket ID
carrierId	string	false	none	Carrier ID
companyId	string	false	none	Company ID
driverId	string	false	none	Driver ID
vehicleId	string	false	none	Vehicle ID
notes	string	false	none	none
inboundAction	string	false	none	Inbound action
inboundCustomerIds	[string]	false	none	Inbound customer IDs
inboundReceiptIds	[string]	false	none	Inbound receipt IDs
inboundPhotoIds	[string]	false	none	Inbound photo IDs
outboundAction	string	false	none	Outbound action
outboundCustomerIds	[string]	false	none	Outbound customer IDs
outboundPhotoIds	[string]	false	none	Outbound photo IDs
pickUpEquipmentIds	[string]	false	none	Pick up equipment IDs
inYardAction	string	false	none	In yard action
dropOffLocationId	string	false	none	Drop off location
pickUpLocationId	string	false	none	Pick up location
dropOffEquipmentId	string	false	none	none
outboundLoadIds	[string]	false	none	none
draft	boolean	false	none	none
appointmentId	string	false	none	Appointment ID
checkInComboId	string	false	none	none
outboundProofPhotoIds	[string]	false	none	none
taskEquipmentId	string	false	none	Task equipment ID
loadTaskId	string	false	none	Load task ID
receiveTaskId	string	false	none	Receive task ID
tags	[string]	false	none	List of tags
checkInInfo	EntryCheckInfo (opens in a new tab)	false	none	Driver and vehicle information for entry (JSON)
checkOutInfo	EntryCheckInfo (opens in a new tab)	false	none	Driver and vehicle information for exit (JSON)
createShuttleTaskAfterCheckIn	boolean	false	none	none
createShuttleTaskAfterCheckOut	boolean	false	none	none
forceCheckoutReason	string	false	none	Force checkout reason
customerId	string	false	none	none
entryStatus	string	false	none	none
driverArrivedTime	string	false	none	Driver arrived time at yard
colorTag	string	false	none	Color tag for entry ticket

Enum Values

Property	Value
inboundAction	LIVE_DELIVERY
inboundAction	DROP_OFF_DELIVERY
inboundAction	DROP_OFF_EMPTY
inboundAction	OTHER
outboundAction	LIVE_LOAD
outboundAction	PICK_UP_PRELOAD
outboundAction	PICK_UP_EMPTY
outboundAction	OTHER
inYardAction	DROP_OFF_RECEIVING
inYardAction	PRE_LOAD
inYardAction	PARKING
inYardAction	VISITOR
entryStatus	NEW
entryStatus	PRE_ENTRY
entryStatus	GATE_CHECKED_IN
entryStatus	WAITING
entryStatus	NEED_WINDOW_CHECK_IN
entryStatus	WINDOW_CHECKED_IN
entryStatus	DOCK_CHECKED_IN
entryStatus	DOCK_CHECKED_OUT
entryStatus	GATE_CHECK_OUT
entryStatus	REJECTED
entryStatus	DROPPING_OFF_DELIVERY
entryStatus	DROPPING_OFF_EMPTY
entryStatus	PICKING_UP_PRELOAD
entryStatus	PICKING_UP_EMPTY
entryStatus	FORCE_CHECKED_OUT

Entry Ticket Create CMD Page Result Entry Ticket View