API Docs
YMS API
Data Models
Equipment
Equipment Status View

EquipmentStatusView

{
  "id": 0,
  "equipmentId": "string",
  "equipmentNo": "string",
  "equipmentType": "VEHICLE",
  "carrierId": "string",
  "customerId": "string",
  "inYard": true,
  "yardId": "string",
  "locationId": "string",
  "previousLocationId": "string",
  "locationType": "DOCK",
  "lastCheckInTime": "string",
  "lastCheckOutTime": "string",
  "lastEntryId": "string",
  "createdTime": "string",
  "createdBy": "string",
  "updatedTime": "string",
  "updatedBy": "string",
  "checkInEntry": "string",
  "cargoStatus": "UNKNOWN",
  "sealNumber": "string",
  "sealNumberPhoto": "string",
  "equipmentCondition": "UNKNOWN",
  "description": "string",
  "equipmentPhotos": [
    "string"
  ],
  "customerName": "string",
  "carrierName": "string",
  "locationName": "string",
  "equipmentDetailView": {
    "id": 0,
    "equipmentId": "string",
    "equipmentType": "VEHICLE",
    "vehicleType": "BOX_TRUCK",
    "equipmentNo": "string",
    "equipmentNoPhoto": "string",
    "reefer": true,
    "createdTime": "string",
    "createdBy": "string",
    "updatedTime": "string",
    "updatedBy": "string",
    "trailerSize": "OTHER",
    "equipmentStatusView": {
      "id": 0,
      "equipmentId": "string",
      "equipmentNo": "string",
      "equipmentType": "VEHICLE",
      "carrierId": "string",
      "customerId": "string",
      "inYard": true,
      "yardId": "string",
      "locationId": "string",
      "previousLocationId": "string",
      "locationType": "DOCK",
      "lastCheckInTime": "string",
      "lastCheckOutTime": "string",
      "lastEntryId": "string",
      "createdTime": "string",
      "createdBy": "string",
      "updatedTime": "string",
      "updatedBy": "string",
      "checkInEntry": "string",
      "cargoStatus": "UNKNOWN",
      "sealNumber": "string",
      "sealNumberPhoto": "string",
      "equipmentCondition": "UNKNOWN",
      "description": "string",
      "equipmentPhotos": [
        "string"
      ],
      "customerName": "string",
      "carrierName": "string",
      "locationName": "string",
      "equipmentDetailView": {
        "id": 0,
        "equipmentId": "string",
        "equipmentType": "VEHICLE",
        "vehicleType": "BOX_TRUCK",
        "equipmentNo": "string",
        "equipmentNoPhoto": "string",
        "reefer": true,
        "createdTime": "string",
        "createdBy": "string",
        "updatedTime": "string",
        "updatedBy": "string",
        "trailerSize": "OTHER",
        "equipmentStatusView": {
          "id": null,
          "equipmentId": null,
          "equipmentNo": null,
          "equipmentType": null,
          "carrierId": null,
          "customerId": null,
          "inYard": null,
          "yardId": null,
          "locationId": null,
          "previousLocationId": null,
          "locationType": null,
          "lastCheckInTime": null,
          "lastCheckOutTime": null,
          "lastEntryId": null,
          "createdTime": null,
          "createdBy": null,
          "updatedTime": null,
          "updatedBy": null,
          "checkInEntry": null,
          "cargoStatus": null,
          "sealNumber": null,
          "sealNumberPhoto": null,
          "equipmentCondition": null,
          "description": null,
          "equipmentPhotos": null,
          "customerName": null,
          "carrierName": null,
          "locationName": null,
          "equipmentDetailView": null,
          "missingCount": null,
          "receiptViews": null,
          "loadViews": null,
          "referenceNos": null,
          "companyCode": null,
          "equipmentOperationStatus": null,
          "vehicleType": null,
          "rfidCode": null,
          "taskViews": null,
          "entryTicketType": null
        },
        "containerSize": "SIZE_53",
        "containerNo": "string",
        "locationName": "string",
        "locationId": "string",
        "rfidCode": "string"
      },
      "missingCount": 0,
      "receiptViews": [
        {
          "id": 0,
          "receiptId": "string",
          "receiptStatus": "string",
          "receiptType": "string",
          "poNo": "string",
          "carrierId": "string",
          "customerId": "string",
          "referenceNo": "string",
          "equipmentType": "string",
          "equipmentNo": "string",
          "totalPalletQty": 0,
          "itemLines": [
            null
          ],
          "appointmentTime": "string",
          "appointmentId": "string",
          "sealNo": "string",
          "dataChannel": "[",
          "eventTime": "string",
          "extraData": "string",
          "carrierName": "string",
          "customerName": "string",
          "dynamicFieldValues": [
            null
          ],
          "proNos": [
            null
          ],
          "invoicePros": [
            null
          ],
          "doNos": [
            null
          ],
          "tripNo": "string"
        }
      ],
      "loadViews": [
        {
          "id": "string",
          "loadId": "LOAD-12345",
          "loadStatus": "string",
          "loadNo": "string",
          "shipMethod": "string",
          "carrierId": "string",
          "appointmentTime": "2025-08-08T10:00:00",
          "appointmentId": "string",
          "orderIds": [
            null
          ],
          "customerId": "string",
          "masterBol": "string",
          "sealNo": "123456",
          "customerName": "string",
          "carrierName": "string",
          "orderViews": [
            null
          ],
          "dynamicFieldValues": [
            null
          ],
          "equipmentType": "TRAILER",
          "equipmentNo": "string",
          "referenceNoList": [
            null
          ],
          "poNoList": [
            null
          ],
          "templateLoadKey": "string",
          "proNos": [
            null
          ],
          "invoicePros": [
            null
          ],
          "doNos": [
            null
          ],
          "tripNos": [
            null
          ],
          "loadType": "string",
          "stagingLocationName": "string",
          "shippedTime": "string"
        }
      ],
      "referenceNos": [
        "string"
      ],
      "companyCode": "string",
      "equipmentOperationStatus": "DROP_OFF_FULL",
      "vehicleType": "BOX_TRUCK",
      "rfidCode": "string",
      "taskViews": [
        {
          "id": 0,
          "taskId": "string",
          "taskType": "[",
          "timeStatus": "[",
          "startTime": "string",
          "lastPauseTime": "string",
          "endTime": "string",
          "totalRunTime": 0,
          "totalPausedTime": 0,
          "createdTime": "string",
          "updatedTime": "string",
          "createdBy": "string",
          "updatedBy": "string",
          "assignUserName": "string",
          "plannedLocationId": "string",
          "assignLocationId": "string",
          "assignLocationName": "string",
          "customerId": "string",
          "customerName": "string",
          "entryId": "string",
          "loadIds": [
            null
          ],
          "receiptIds": [
            null
          ],
          "taskStatus": "[",
          "assigneeUserId": "string",
          "description": "string",
          "priority": "string",
          "note": "string",
          "lastStepAssignedUserIds": [
            null
          ],
          "planedLastStepAssignedUserIds": [
            null
          ],
          "lastStepAssignedUserNames": [
            null
          ],
          "planedLastStepAssignedUserNames": [
            null
          ],
          "lastStepId": "string",
          "planedAssignAllSteps": true
        }
      ],
      "entryTicketType": "string"
    },
    "containerSize": "SIZE_53",
    "containerNo": "string",
    "locationName": "string",
    "locationId": "string",
    "rfidCode": "string"
  },
  "missingCount": 0,
  "receiptViews": [
    {
      "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"
    }
  ],
  "loadViews": [
    {
      "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"
    }
  ],
  "referenceNos": [
    "string"
  ],
  "companyCode": "string",
  "equipmentOperationStatus": "DROP_OFF_FULL",
  "vehicleType": "BOX_TRUCK",
  "rfidCode": "string",
  "taskViews": [
    {
      "id": 0,
      "taskId": "string",
      "taskType": "RECEIVE",
      "timeStatus": "NOT_STARTED",
      "startTime": "string",
      "lastPauseTime": "string",
      "endTime": "string",
      "totalRunTime": 0,
      "totalPausedTime": 0,
      "createdTime": "string",
      "updatedTime": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "assignUserName": "string",
      "plannedLocationId": "string",
      "assignLocationId": "string",
      "assignLocationName": "string",
      "customerId": "string",
      "customerName": "string",
      "entryId": "string",
      "loadIds": [
        "string"
      ],
      "receiptIds": [
        "string"
      ],
      "taskStatus": "NEW",
      "assigneeUserId": "string",
      "description": "string",
      "priority": "string",
      "note": "string",
      "lastStepAssignedUserIds": [
        "string"
      ],
      "planedLastStepAssignedUserIds": [
        "string"
      ],
      "lastStepAssignedUserNames": [
        "string"
      ],
      "planedLastStepAssignedUserNames": [
        "string"
      ],
      "lastStepId": "string",
      "planedAssignAllSteps": true
    }
  ],
  "entryTicketType": "string"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
idinteger(int64)falsenonenone
equipmentIdstringfalsenoneEquipment ID
equipmentNostringfalsenoneEquipment number
equipmentTypestringfalsenoneEquipment type
carrierIdstringfalsenoneCarrier ID
customerIdstringfalsenoneCustomer ID
inYardbooleanfalsenoneIs in yard
yardIdstringfalsenoneYard ID
locationIdstringfalsenoneLocation ID
previousLocationIdstringfalsenonePrevious location ID
locationTypestringfalsenonenone
lastCheckInTimestringfalsenoneLast check in time
lastCheckOutTimestringfalsenoneLast check out time
lastEntryIdstringfalsenoneLast entry ID
createdTimestringfalsenoneCreated time
createdBystringfalsenoneCreated by
updatedTimestringfalsenoneUpdated time
updatedBystringfalsenoneUpdated by
checkInEntrystringfalsenoneCheck-in entry identifier
cargoStatusstringfalsenoneCargo status
sealNumberstringfalsenoneSeal number
sealNumberPhotostringfalsenoneSeal number photo
equipmentConditionstringfalsenoneEquipment condition
descriptionstringfalsenoneDescription
equipmentPhotos[string]falsenonenone
customerNamestringfalsenonenone
carrierNamestringfalsenonenone
locationNamestringfalsenonenone
equipmentDetailViewEquipmentView (opens in a new tab)falsenonenone
missingCountintegerfalsenonenone
receiptViews[ReceiptView (opens in a new tab)]falsenonenone
loadViews[LoadView (opens in a new tab)]falsenonenone
referenceNos[string]falsenonenone
companyCodestringfalsenoneCompany code (UT, UF, CUBEWORK)
equipmentOperationStatusstringfalsenonenone
vehicleTypestringfalsenonenone
rfidCodestringfalsenoneRFID tag code
taskViews[GeneralTaskView (opens in a new tab)]falsenoneTask views list
entryTicketTypestringfalsenoneEntry ticket type, contains inYardAction, inboundAction, outboundAction joined by comma

Enum Values

PropertyValue
equipmentTypeVEHICLE
equipmentTypeTRAILER
equipmentTypeCHASSIS
equipmentTypeCONTAINER
equipmentTypeFLATBED
equipmentTypeOTHER
equipmentTypeNO_EQUIPMENT
locationTypeDOCK
locationTypeSPOT
locationTypeSTAGING
locationTypeLOCATION
cargoStatusUNKNOWN
cargoStatusFULL
cargoStatusEMPTY
cargoStatusFULL_AFTER_LOADED
cargoStatusEMPTY_AFTER_OFFLOAD
equipmentConditionUNKNOWN
equipmentConditionGOOD
equipmentConditionDAMAGED
equipmentOperationStatusDROP_OFF_FULL
equipmentOperationStatusFULL_TO_OFFLOAD
equipmentOperationStatusDROP_OFF_EMPTY
equipmentOperationStatusEMPTY_TO_LOAD
equipmentOperationStatusFULL_AFTER_LOADED
equipmentOperationStatusEMPTY_AFTER_OFFLOADED
equipmentOperationStatusLOAD_WAITING
equipmentOperationStatusOFFLOAD_WAITING
equipmentOperationStatusLOADING
equipmentOperationStatusOFFLOADING
equipmentOperationStatusUNKNOW
vehicleTypeBOX_TRUCK
vehicleTypeCAR
vehicleTypeTRACTOR
vehicleTypeOTHER