API Docs
YMS API
Data Models
Load
Load Update CMD

LoadUpdateCmd

{
  "loadStatus": "NEW",
  "loadNo": "string",
  "shipMethod": "TRUCK_LOAD",
  "carrierId": "string",
  "appointmentTime": "2025-08-08T10:00:00",
  "appointmentId": "string",
  "orderIds": [
    "string"
  ],
  "customerId": "string",
  "masterBol": "string",
  "sealNo": "123456",
  "dynamicFieldValues": [
    {
      "entityId": "string",
      "entityType": "RECEIPT",
      "fieldCode": "string",
      "shortValue": "string",
      "longValue": "string",
      "value": "string"
    }
  ],
  "equipmentType": "TRAILER",
  "equipmentNo": "string"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
loadStatusstringfalsenoneCurrent status of the load. Allowed values: NEW, WINDOW_CHECKIN_DONE, LOADING, LOADED, SHIPPED, CANCELLED
loadNostringfalsenoneHuman-readable load number or reference
shipMethodstringfalsenoneShipping method
carrierIdstringfalsenoneAssociated carrier identifier
appointmentTimestringfalsenoneAppointment time
appointmentIdstringfalsenoneRelated appointment identifier
orderIds[string]falsenoneList of related order identifiers
customerIdstringfalsenoneAssociated customer identifier
masterBolstringfalsenoneMaster bill of lading number
sealNostringfalsenoneSeal number used on the trailer or container
dynamicFieldValues[DynamicFieldValueCreateCmd (opens in a new tab)]falsenoneDynamic field values for custom attributes
equipmentTypestringfalsenoneEquipment type,allowed values: TRAILER,CONTAINER,CHASSIS,FLATBED,OTHER
equipmentNostringfalsenoneEquipment number

Enum Values

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