API Docs
YMS API
Data Models
Entry Ticket
Entry Ticket Update CMD

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

NameTypeRequiredConstraintsChinese NameDescription
entryIdstringtruenoneEntry ticket ID
carrierIdstringfalsenoneCarrier ID
companyIdstringfalsenoneCompany ID
driverIdstringfalsenoneDriver ID
vehicleIdstringfalsenoneVehicle ID
notesstringfalsenonenone
inboundActionstringfalsenoneInbound action
inboundCustomerIds[string]falsenoneInbound customer IDs
inboundReceiptIds[string]falsenoneInbound receipt IDs
inboundPhotoIds[string]falsenoneInbound photo IDs
outboundActionstringfalsenoneOutbound action
outboundCustomerIds[string]falsenoneOutbound customer IDs
outboundPhotoIds[string]falsenoneOutbound photo IDs
pickUpEquipmentIds[string]falsenonePick up equipment IDs
inYardActionstringfalsenoneIn yard action
dropOffLocationIdstringfalsenoneDrop off location
pickUpLocationIdstringfalsenonePick up location
dropOffEquipmentIdstringfalsenonenone
outboundLoadIds[string]falsenonenone
draftbooleanfalsenonenone
appointmentIdstringfalsenoneAppointment ID
checkInComboIdstringfalsenonenone
outboundProofPhotoIds[string]falsenonenone
taskEquipmentIdstringfalsenoneTask equipment ID
loadTaskIdstringfalsenoneLoad task ID
receiveTaskIdstringfalsenoneReceive task ID
tags[string]falsenoneList of tags
checkInInfoEntryCheckInfofalsenoneDriver and vehicle information for entry (JSON)
checkOutInfoEntryCheckInfofalsenoneDriver and vehicle information for exit (JSON)
createShuttleTaskAfterCheckInbooleanfalsenonenone
createShuttleTaskAfterCheckOutbooleanfalsenonenone
forceCheckoutReasonstringfalsenoneForce checkout reason
customerIdstringfalsenonenone
entryStatusstringfalsenonenone
driverArrivedTimestringfalsenoneDriver arrived time at yard
colorTagstringfalsenoneColor tag for entry ticket

Enum Values

PropertyValue
inboundActionLIVE_DELIVERY
inboundActionDROP_OFF_DELIVERY
inboundActionDROP_OFF_EMPTY
inboundActionOTHER
outboundActionLIVE_LOAD
outboundActionPICK_UP_PRELOAD
outboundActionPICK_UP_EMPTY
outboundActionOTHER
inYardActionDROP_OFF_RECEIVING
inYardActionPRE_LOAD
inYardActionPARKING
inYardActionVISITOR
entryStatusNEW
entryStatusPRE_ENTRY
entryStatusGATE_CHECKED_IN
entryStatusWAITING
entryStatusNEED_WINDOW_CHECK_IN
entryStatusWINDOW_CHECKED_IN
entryStatusDOCK_CHECKED_IN
entryStatusDOCK_CHECKED_OUT
entryStatusGATE_CHECK_OUT
entryStatusREJECTED
entryStatusDROPPING_OFF_DELIVERY
entryStatusDROPPING_OFF_EMPTY
entryStatusPICKING_UP_PRELOAD
entryStatusPICKING_UP_EMPTY
entryStatusFORCE_CHECKED_OUT