API Docs
YMS API
Data Models
Entry Ticket
Entry Ticket Query

EntryTicketQuery

{
  "currentPage": 0,
  "pageSize": 0,
  "sortingFields": [
    {
      "field": "string",
      "orderBy": "NONE"
    }
  ],
  "id": 0,
  "ids": [
    0
  ],
  "entryId": "string",
  "regexEntry": "string",
  "entryIds": [
    "string"
  ],
  "fuzzyEntryId": "string",
  "carrierId": "string",
  "carrierIds": [
    "string"
  ],
  "companyId": "string",
  "driverLicense": "string",
  "driverId": "string",
  "driverIds": [
    "string"
  ],
  "orDriverIds": [
    "string"
  ],
  "orCarrierIds": [
    "string"
  ],
  "orVehicleIds": [
    "string"
  ],
  "inboundActionType": [
    "LIVE_DELIVERY"
  ],
  "outboundActionType": [
    "LIVE_LOAD"
  ],
  "inYardActionType": [
    "DROP_OFF_RECEIVING"
  ],
  "entryTypes": [
    "string"
  ],
  "vehicleId": "string",
  "vehicleIds": [
    "string"
  ],
  "entryStatus": "NEW",
  "statuses": [
    "NEW"
  ],
  "excludeStatuses": "List.of(EntryTicketStatus.NEW)",
  "inYardAction": "DROP_OFF_RECEIVING",
  "createdSource": "SELF_CHECKIN",
  "createdSources": [
    "SELF_CHECKIN"
  ],
  "dropOffLocationId": "string",
  "pickUpLocationId": "string",
  "inboundAction": "LIVE_DELIVERY",
  "outboundAction": "LIVE_LOAD",
  "inboundCustomerIds": [
    "string"
  ],
  "outboundCustomerIds": [
    "string"
  ],
  "pickUpEquipmentIds": [
    "string"
  ],
  "inboundReceiptIds": [
    "string"
  ],
  "inboundReceiptId": "string",
  "outboundLoadIds": [
    "string"
  ],
  "outboundLoadId": "string",
  "appointmentId": "string",
  "appointmentIds": [
    "string"
  ],
  "taskEquipmentId": "string",
  "taskEquipmentIds": [
    "string"
  ],
  "loadTaskId": "string",
  "loadTaskIds": [
    "string"
  ],
  "receiveTaskId": "string",
  "receiveTaskIds": [
    "string"
  ],
  "windowCheckInTimePeriod": [
    "string"
  ],
  "checkInStartTimePeriod": [
    "string"
  ],
  "keyword": "string",
  "customerIds": [
    "string"
  ],
  "hasAppointment": true,
  "checkInEndTimePeriod": [
    "string"
  ],
  "nonAppointment": true,
  "relatedLoadIds": true
}

Properties

NameTypeRequiredConstraintsChinese NameDescription
currentPageintegerfalsenonenone
pageSizeintegerfalsenonenone
sortingFields[SortingField]falsenonenone
idinteger(int64)falsenoneEntry ticket ID
ids[integer]falsenoneEntry ticket IDs
entryIdstringfalsenoneEntry ticket ID
regexEntrystringfalsenoneEntry ticket ID
entryIds[string]falsenoneEntry ticket IDs
fuzzyEntryIdstringfalsenonenone
carrierIdstringfalsenoneCarrier ID
carrierIds[string]falsenoneCarrier ID
companyIdstringfalsenoneCompany ID
driverLicensestringfalsenonenone
driverIdstringfalsenoneDriver ID
driverIds[string]falsenonenone
orDriverIds[string]falsenonenone
orCarrierIds[string]falsenonenone
orVehicleIds[string]falsenonenone
inboundActionType[string]falsenoneEntry type, replaces the original entryTypes field
Uses new independent fields to handle different types of entry operations
outboundActionType[string]falsenonenone
inYardActionType[string]falsenonenone
entryTypes[string]falsenoneThe original entryTypes field is retained as input, but not used directly for queries
vehicleIdstringfalsenoneVehicle ID
vehicleIds[string]falsenoneVehicle IDs
entryStatusstringfalsenoneEntry ticket status
statuses[string]falsenoneStatuses
excludeStatuses[string]falsenonenone
inYardActionstringfalsenoneIn yard action
createdSourcestringfalsenoneCreated source
createdSources[string]falsenonenone
dropOffLocationIdstringfalsenoneDrop off location
pickUpLocationIdstringfalsenonePick up location
inboundActionstringfalsenoneInbound action
outboundActionstringfalsenoneOutbound action
inboundCustomerIds[string]falsenoneInbound customer IDs
outboundCustomerIds[string]falsenoneOutbound customer IDs
pickUpEquipmentIds[string]falsenonePick up equipment IDs
inboundReceiptIds[string]falsenoneInbound customer IDs
inboundReceiptIdstringfalsenone@QueryCondition(field = "inboundReceiptIds", operator = QueryOperator.FTS)
outboundLoadIds[string]falsenone@QueryCondition(field = "outboundLoadIds", operator = QueryOperator.FTS_IN_ARRAY)
outboundLoadIdstringfalsenone@QueryCondition(field = "outboundLoadIds", operator = QueryOperator.FTS)
appointmentIdstringfalsenoneAppointment ID
appointmentIds[string]falsenoneAppointment IDs
taskEquipmentIdstringfalsenoneTask equipment ID
taskEquipmentIds[string]falsenoneTask equipment IDs
loadTaskIdstringfalsenoneLoad task ID
loadTaskIds[string]falsenoneLoad task IDs
receiveTaskIdstringfalsenoneReceive task ID
receiveTaskIds[string]falsenoneReceive task IDs
windowCheckInTimePeriod[string]falsenonenone
checkInStartTimePeriod[string]falsenonenone
keywordstringfalsenonekeyword
customerIds[string]falsenonenone
hasAppointmentbooleanfalsenonenone
checkInEndTimePeriod[string]falsenonenone
nonAppointmentbooleanfalsenonenone
relatedLoadIdsbooleanfalsenonenone

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
createdSourceSELF_CHECKIN
createdSourcePRE_CHECKIN
createdSourcePRE_SELF
createdSourceYMS_CHECK_IN
createdSourceWMS_CHECK_IN
createdSourceMANUAL_CHECK_IN
createdSourceYARD_CHECK
createdSourceMANUAL_GATE_CHECKIN
inboundActionLIVE_DELIVERY
inboundActionDROP_OFF_DELIVERY
inboundActionDROP_OFF_EMPTY
inboundActionOTHER
outboundActionLIVE_LOAD
outboundActionPICK_UP_PRELOAD
outboundActionPICK_UP_EMPTY
outboundActionOTHER
RPage Result Entry Ticket ViewEntry Ticket Timeline View