API Docs
YMS API
Data Models
Entry Ticket
Entry Ticket View

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": [
          {
            "id": null,
            "customerId": null,
            "status": null,
            "exceptionCode": null,
            "sysNote": null,
            "note": null,
            "customerName": null,
            "stepType": null,
            "taskId": null,
            "taskType": null,
            "stepSequence": null,
            "assigneeUserIds": null,
            "assigneeUserNames": null,
            "lastAssignedWhen": null,
            "priority": null,
            "startTime": null,
            "endTime": null
          }
        ],
        "createdSource": "SELF_CHECKIN",
        "customerId": "string",
        "customerName": "string",
        "inbound": {
          "customerId": "string",
          "customerName": "string",
          "receiptIds": [
            null
          ],
          "equipmentType": "[",
          "equipmentNo": "string",
          "locationId": "string",
          "locationName": "string"
        },
        "outbound": {
          "customerId": "string",
          "customerName": "string",
          "loads": [
            null
          ],
          "equipmentType": "[",
          "equipmentNo": "string",
          "locationId": "string",
          "locationName": "string"
        },
        "equipmentType": "VEHICLE",
        "equipmentNo": "string",
        "dockId": "string",
        "dockName": "string",
        "rejectReason": "string",
        "action": "GATE_CHECK_IN"
      },
      "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": "VEHICLE",
        "photos": [
          "string"
        ]
      }
    ],
    "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": "VEHICLE",
        "photos": [
          "string"
        ]
      }
    ],
    "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": "string",
          "itemName": "string",
          "itemQty": "string",
          "palletQty": "string",
          "itemSpecDesc": "string",
          "itemSpecName": "string",
          "uomId": "string",
          "qty": "string"
        }
      ],
      "appointmentTime": "string",
      "appointmentId": "string",
      "sealNo": "string",
      "dataChannel": "YMS",
      "eventTime": "string",
      "extraData": "string",
      "carrierName": "string",
      "customerName": "string",
      "dynamicFieldValues": [
        {
          "entityId": "string",
          "entityType": "RECEIPT",
          "fieldCode": "string",
          "value": "string",
          "fieldName": "string",
          "longValue": "string",
          "shortValue": "string"
        }
      ],
      "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": 0,
          "orderId": "string",
          "orderStatus": "string",
          "customerId": "string",
          "poNo": "string",
          "referenceNo": "string",
          "retailer": "string",
          "shipFrom": "string",
          "shipTo": "string",
          "totalPalletQty": 0,
          "totalCartonQty": 0,
          "itemInfos": [
            {}
          ],
          "customerName": "string",
          "carrierName": "string",
          "shipToAddress": {
            "id": null,
            "name": null,
            "country": null,
            "state": null,
            "city": null,
            "zipCode": null,
            "fax": null,
            "address1": null,
            "address2": null,
            "contact": null,
            "phone": null,
            "extension": null,
            "email": null,
            "orgId": null,
            "orgName": null,
            "referenceNo": null,
            "batchCode": null,
            "storeNo": null,
            "shorthand": null,
            "toHome": null,
            "tags": null,
            "latitude": null,
            "longitude": null,
            "crmAddressId": null
          },
          "shipFromAddress": {
            "id": null,
            "name": null,
            "country": null,
            "state": null,
            "city": null,
            "zipCode": null,
            "fax": null,
            "address1": null,
            "address2": null,
            "contact": null,
            "phone": null,
            "extension": null,
            "email": null,
            "orgId": null,
            "orgName": null,
            "referenceNo": null,
            "batchCode": null,
            "storeNo": null,
            "shorthand": null,
            "toHome": null,
            "tags": null,
            "latitude": null,
            "longitude": null,
            "crmAddressId": null
          },
          "appointmentTime": "string",
          "dynamicFieldValues": [
            {}
          ],
          "proNos": [
            "string"
          ],
          "invoicePros": [
            "string"
          ],
          "doNos": [
            "string"
          ],
          "tripNo": "string",
          "shippedTime": "string"
        }
      ],
      "dynamicFieldValues": [
        {
          "entityId": "string",
          "entityType": "RECEIPT",
          "fieldCode": "string",
          "value": "string",
          "fieldName": "string",
          "longValue": "string",
          "shortValue": "string"
        }
      ],
      "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"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
idinteger(int64)falsenoneDatabase ID
entryIdstringfalsenoneEntry ticket unique identifier
carrierIdstringfalsenoneCarrier ID
companyIdstringfalsenoneCompany ID
driverIdstringfalsenoneDriver ID
vehicleIdstringfalsenoneVehicle ID
checkInComboIdstringfalsenoneCheck-in combination ID
checkOutComboIdstringfalsenoneCheck-out combination ID
checkInStartTimestringfalsenoneCheck-in start time
checkInEndTimestringfalsenoneCheck-in end time
checkOutStartTimestringfalsenoneCheck-out start time
checkOutEndTimestringfalsenoneCheck-out end time
notesstringfalsenoneAdditional notes
entryStatusstringfalsenoneEntry ticket status
rejectReasonstringfalsenoneReason for rejection
forceCheckoutReasonstringfalsenoneReason for forced checkout
tags[string]falsenoneList of tags associated with the entry ticket
inYardActionstringfalsenoneAction performed in yard
inboundActionstringfalsenoneInbound action type
outboundActionstringfalsenoneOutbound action type
createdSourcestringfalsenoneSource of entry ticket creation
createdTimestringfalsenoneCreation time
createdBystringfalsenoneCreated by
updatedTimestringfalsenoneLast update time
updatedBystringfalsenoneLast updated by
customerIdstringfalsenoneMaster customer ID
dropOffLocationIdstringfalsenoneDrop-off location ID
dropOffLocationTypestringfalsenoneDrop-off location type
pickUpLocationIdstringfalsenonePick-up location ID
pickUpLocationTypestringfalsenonePick-up location type
dropOffLocationNamestringfalsenoneDrop-off location name
pickUpLocationNamestringfalsenonePick-up location name
carrierViewCarrierViewfalsenoneCarrier information
driverViewDriverViewfalsenoneDriver information
vehicleViewVehicleViewfalsenoneVehicle information
inboundCustomerIds[string]falsenoneList of inbound customer IDs
inboundReceiptIds[string]falsenoneList of inbound receipt IDs
inboundPhotoIds[string]falsenoneList of inbound photo IDs
outboundCustomerIds[string]falsenoneList of outbound customer IDs
outboundPhotoIds[string]falsenoneList of outbound photo IDs
outboundProofPhotoIds[string]falsenoneList of outbound proof photo IDs
pickUpEquipmentIds[string]falsenoneList of equipment IDs for pick-up
timeLines[EntryTicketTimelineView]falsenoneTimeline of entry ticket events
outboundLoadIds[string]falsenoneList of outbound load IDs
appointmentIdstringfalsenoneAssociated appointment ID
taskEquipmentIdstringfalsenoneTask equipment ID
loadTaskIdstringfalsenoneLoad task ID
loadTaskAssignUserNamestringfalsenoneLoad task assignee user name
receiveTaskIdstringfalsenoneReceive task ID
receiveTaskAssignUserNamestringfalsenoneReceive task assignee user name
inboundCustomerNames[string]falsenoneList of inbound customer names
outboundCustomerNames[string]falsenoneList of outbound customer names
dropOffEquipmentIdstringfalsenoneDrop-off equipment ID
yardIdstringfalsenoneYard ID
createShuttleTaskAfterCheckInbooleanfalsenoneWhether to create shuttle task after check-in, default is false
createShuttleTaskAfterCheckOutbooleanfalsenoneWhether to create shuttle task after check-out, default is false
checkInInfoEntryCheckInfoViewfalsenoneCheck-in driver and vehicle information
checkOutInfoEntryCheckInfoViewfalsenoneCheck-out driver and vehicle information
preEquipmentInfoPreEquipmentInfofalsenonePre-defined equipment information
pickUpEquipmentInfos[PreEquipmentInfo]falsenoneList of equipment information for pick-up
dropOffEquipmentInfoPreEquipmentInfofalsenoneEquipment information for drop-off
errorInfoEntryCheckInfoErrorInfofalsenoneError information for check-in process
taskAssigneestringfalsenoneTask assignee
customerNamestringfalsenoneCustomer name
tripNos[string]falsenoneTrip numbers
receiptListView[ReceiptView]falsenonereceiptListView
loadListView[LoadView]falsenoneloadListView
preEntryIdstringfalsenonepreEntryId
driverArrivedTimestringfalsenoneDriver arrived time at yard
colorTagstringfalsenoneColor tag for entry ticket
inboundSealNostringfalsenoneLatest inbound seal number
outboundSealNostringfalsenoneLatest outbound seal number
currentSealNostringfalsenoneCurrent seal number (latest by createdTime)

Enum Values

PropertyValue
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
inYardActionDROP_OFF_RECEIVING
inYardActionPRE_LOAD
inYardActionPARKING
inYardActionVISITOR
inboundActionLIVE_DELIVERY
inboundActionDROP_OFF_DELIVERY
inboundActionDROP_OFF_EMPTY
inboundActionOTHER
outboundActionLIVE_LOAD
outboundActionPICK_UP_PRELOAD
outboundActionPICK_UP_EMPTY
outboundActionOTHER
createdSourceSELF_CHECKIN
createdSourcePRE_CHECKIN
createdSourcePRE_SELF
createdSourceYMS_CHECK_IN
createdSourceWMS_CHECK_IN
createdSourceMANUAL_CHECK_IN
createdSourceYARD_CHECK
dropOffLocationTypeDOCK
dropOffLocationTypeSPOT
dropOffLocationTypeSTAGING
dropOffLocationTypeLOCATION
pickUpLocationTypeDOCK
pickUpLocationTypeSPOT
pickUpLocationTypeSTAGING
pickUpLocationTypeLOCATION