API Docs
YMS API
Data Models
Load View

LoadView

{
  "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": [
        {
          "itemId": "string",
          "itemName": "string",
          "itemQty": "string",
          "palletQty": "string",
          "itemSpecDesc": "string",
          "itemSpecName": "string",
          "uomId": "string",
          "qty": "string"
        }
      ],
      "customerName": "string",
      "carrierName": "string",
      "shipToAddress": {
        "id": "string",
        "name": "string",
        "country": "string",
        "state": "string",
        "city": "string",
        "zipCode": "string",
        "fax": "string",
        "address1": "string",
        "address2": "string",
        "contact": "string",
        "phone": "string",
        "extension": "string",
        "email": "string",
        "orgId": "string",
        "orgName": "string",
        "referenceNo": "string",
        "batchCode": "string",
        "storeNo": "string",
        "shorthand": "string",
        "toHome": true,
        "tags": [
          "string"
        ],
        "latitude": "string",
        "longitude": "string",
        "crmAddressId": "string"
      },
      "shipFromAddress": {
        "id": "string",
        "name": "string",
        "country": "string",
        "state": "string",
        "city": "string",
        "zipCode": "string",
        "fax": "string",
        "address1": "string",
        "address2": "string",
        "contact": "string",
        "phone": "string",
        "extension": "string",
        "email": "string",
        "orgId": "string",
        "orgName": "string",
        "referenceNo": "string",
        "batchCode": "string",
        "storeNo": "string",
        "shorthand": "string",
        "toHome": true,
        "tags": [
          "string"
        ],
        "latitude": "string",
        "longitude": "string",
        "crmAddressId": "string"
      },
      "appointmentTime": "string",
      "dynamicFieldValues": [
        {
          "entityId": "string",
          "entityType": "RECEIPT",
          "fieldCode": "string",
          "value": "string",
          "fieldName": "string",
          "longValue": "string",
          "shortValue": "string"
        }
      ],
      "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"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
idstringfalsenoneUnique numeric identifier for the load record
loadIdstringfalsenoneLoad identifier
loadStatusstringfalsenoneCurrent status of the load
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
customerNamestringfalsenoneCustomer name
carrierNamestringfalsenoneCarrier name
orderViews[OrderView (opens in a new tab)]falsenoneOrder details associated with the load
dynamicFieldValues[DynamicFieldValueView (opens in a new tab)]falsenoneDynamic field values for custom attributes
equipmentTypestringfalsenoneEquipment type for the load,values: TRAILER,CONTAINER,CHASSIS,FLATBED,OTHER
equipmentNostringfalsenoneEquipment number
referenceNoList[string]falsenoneList of reference numbers
poNoList[string]falsenoneList of PO numbers
templateLoadKeystringfalsenoneTemplate load key used for generating loads from templates
proNos[string]falsenoneList of PRO numbers
invoicePros[string]falsenoneList of invoice PRO numbers
doNos[string]falsenoneList of delivery order numbers
tripNos[string]falsenoneList of trip numbers
loadTypestringfalsenoneLoad Type (From WMS or configuration)
Type Matching for Location Recommendations
loadType
stagingLocationNamestringfalsenonestagingLocationName
shippedTimestringfalsenoneshippedTime