API Docs
YMS API
Data Models
Equipment
Equipment View

EquipmentView

{
  "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": 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": null,
          "equipmentId": null,
          "equipmentType": null,
          "vehicleType": null,
          "equipmentNo": null,
          "equipmentNoPhoto": null,
          "reefer": null,
          "createdTime": null,
          "createdBy": null,
          "updatedTime": null,
          "updatedBy": null,
          "trailerSize": null,
          "equipmentStatusView": null,
          "containerSize": null,
          "containerNo": null,
          "locationName": null,
          "locationId": null,
          "rfidCode": null
        },
        "missingCount": 0,
        "receiptViews": [
          {}
        ],
        "loadViews": [
          {}
        ],
        "referenceNos": [
          "string"
        ],
        "companyCode": "string",
        "equipmentOperationStatus": "DROP_OFF_FULL",
        "vehicleType": "BOX_TRUCK",
        "rfidCode": "string",
        "taskViews": [
          {}
        ],
        "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": null,
            "itemName": null,
            "itemQty": null,
            "palletQty": null,
            "itemSpecDesc": null,
            "itemSpecName": null,
            "uomId": null,
            "qty": null
          }
        ],
        "appointmentTime": "string",
        "appointmentId": "string",
        "sealNo": "string",
        "dataChannel": "YMS",
        "eventTime": "string",
        "extraData": "string",
        "carrierName": "string",
        "customerName": "string",
        "dynamicFieldValues": [
          {
            "entityId": null,
            "entityType": null,
            "fieldCode": null,
            "value": null,
            "fieldName": null,
            "longValue": null,
            "shortValue": null
          }
        ],
        "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": null,
            "orderId": null,
            "orderStatus": null,
            "customerId": null,
            "poNo": null,
            "referenceNo": null,
            "retailer": null,
            "shipFrom": null,
            "shipTo": null,
            "totalPalletQty": null,
            "totalCartonQty": null,
            "itemInfos": null,
            "customerName": null,
            "carrierName": null,
            "shipToAddress": null,
            "shipFromAddress": null,
            "appointmentTime": null,
            "dynamicFieldValues": null,
            "proNos": null,
            "invoicePros": null,
            "doNos": null,
            "tripNo": null,
            "shippedTime": null
          }
        ],
        "dynamicFieldValues": [
          {
            "entityId": null,
            "entityType": null,
            "fieldCode": null,
            "value": null,
            "fieldName": null,
            "longValue": null,
            "shortValue": null
          }
        ],
        "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"
  },
  "containerSize": "SIZE_53",
  "containerNo": "string",
  "locationName": "string",
  "locationId": "string",
  "rfidCode": "string"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
idinteger(int64)falsenoneID
equipmentIdstringfalsenoneEquipment ID
equipmentTypestringfalsenoneEquipment type
vehicleTypestringfalsenonenone
equipmentNostringfalsenoneEquipment number
equipmentNoPhotostringfalsenoneEquipment number photo
reeferbooleanfalsenoneIs reefer
createdTimestringfalsenoneCreated time
createdBystringfalsenoneCreated by
updatedTimestringfalsenoneUpdated time
updatedBystringfalsenoneUpdated by
trailerSizestringfalsenonenone
equipmentStatusViewEquipmentStatusView (opens in a new tab)falsenonenone
containerSizestringfalsenonenone
containerNostringfalsenoneContainer number, only for CONTAINER type
locationNamestringfalsenonenone
locationIdstringfalsenonenone
rfidCodestringfalsenoneRFID tag code

Enum Values

PropertyValue
equipmentTypeVEHICLE
equipmentTypeTRAILER
equipmentTypeCHASSIS
equipmentTypeCONTAINER
equipmentTypeFLATBED
equipmentTypeOTHER
equipmentTypeNO_EQUIPMENT
vehicleTypeBOX_TRUCK
vehicleTypeCAR
vehicleTypeTRACTOR
vehicleTypeOTHER
trailerSizeOTHER
trailerSizeSIZE_53
trailerSizeSIZE_40
trailerSizeSIZE_40H
trailerSizeSIZE_20
trailerSizeSIZE_48
trailerSizeSIZE_45
containerSizeSIZE_53
containerSizeSIZE_40
containerSizeSIZE_40H
containerSizeSIZE_20