API Docs
YMS API
Data Models
Load
Load Query

LoadQuery

{
  "currentPage": 0,
  "pageSize": 0,
  "sortingFields": [
    {
      "field": "string",
      "orderBy": "NONE"
    }
  ],
  "loadId": "string",
  "loadIds": [
    "string"
  ],
  "loadStatus": "string",
  "loadStatuses": [
    "string"
  ],
  "loadNos": [
    "string"
  ],
  "loadNo": "string",
  "loadNoLike": "string",
  "shipMethod": "TRUCK_LOAD",
  "carrierId": "string",
  "carrierIds": [
    "string"
  ],
  "appointmentTimePeriod": [
    "string"
  ],
  "appointmentId": "string",
  "orderIds": [
    "string"
  ],
  "orderId": "string",
  "keyword": "string",
  "keywordWithOrder": "string",
  "customerId": "string",
  "customerIds": [
    "string"
  ],
  "masterBol": "string",
  "bolNos": [
    "string"
  ],
  "masterBolNos": [
    "string"
  ],
  "sealNo": "string",
  "equipmentType": "VEHICLE",
  "equipmentNo": "string",
  "equipmentNos": [
    "string"
  ],
  "equipmentNoLike": "string",
  "trailerNo": "string",
  "appointmentIdIsNull": true,
  "templateLoadKey": "string",
  "searchScenario": "string",
  "referenceNoLike": "string",
  "poNoLike": "string",
  "loadIdLike": "string",
  "poNoGroup": "string",
  "referenceNoGroup": "string",
  "orLoadNo": "string",
  "orLoadId": "string"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
currentPageintegerfalsenonenone
pageSizeintegerfalsenonenone
sortingFields[SortingField (opens in a new tab)]falsenonenone
loadIdstringfalsenoneLoad ID
loadIds[string]falsenoneLoad IDs
loadStatusstringfalsenoneLoad status
loadStatuses[string]falsenoneLoad statuses
loadNos[string]falsenoneLoad numberj
loadNostringfalsenoneLoad number
loadNoLikestringfalsenonefor like query
shipMethodstringfalsenoneShip method
carrierIdstringfalsenoneCarrier ID
carrierIds[string]falsenonenone
appointmentTimePeriod[string]falsenoneAppointment time range
appointmentIdstringfalsenoneAppointment ID
orderIds[string]falsenonenone
orderIdstringfalsenonenone
keywordstringfalsenonenone
keywordWithOrderstringfalsenoneAdvanced search keyword, supports cross-table queries
Possible matching fields:
- Load table: loadId, loadNo
- Order table: orderId, poNo, referenceNo

When this field has a value, other search conditions will be ignored, and only this field will be used for querying
This field does not use the @QueryCondition annotation and requires special handling in the Service layer
customerIdstringfalsenonenone
customerIds[string]falsenonenone
masterBolstringfalsenonenone
bolNos[string]falsenonenone
masterBolNos[string]falsenonenone
sealNostringfalsenoneSeal number
equipmentTypestringfalsenoneEquipment type
equipmentNostringfalsenoneEquipment number
equipmentNos[string]falsenonefor in query
equipmentNoLikestringfalsenonenone
trailerNostringfalsenonenone
appointmentIdIsNullbooleanfalsenonenone
templateLoadKeystringfalsenonenone
searchScenariostringfalsenonenone
referenceNoLikestringfalsenonenone
poNoLikestringfalsenonenone
loadIdLikestringfalsenonenone
poNoGroupstringfalsenonenone
referenceNoGroupstringfalsenonenone
orLoadNostringfalsenonenone
orLoadIdstringfalsenonenone

Enum Values

PropertyValue
shipMethodTRUCK_LOAD
shipMethodSMALL_PARCEL
shipMethodLTL
shipMethodWILL_CALL
equipmentTypeVEHICLE
equipmentTypeTRAILER
equipmentTypeCHASSIS
equipmentTypeCONTAINER
equipmentTypeFLATBED
equipmentTypeOTHER
equipmentTypeNO_EQUIPMENT