API Docs
YMS API
Data Models
Load
Page Result Load View

PageResultLoadView

{
  "list": [
    {
      "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"
    }
  ],
  "totalCount": 0,
  "currentPage": 0,
  "pageSize": 0,
  "totalPage": 0
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
list[LoadView (opens in a new tab)]falsenonenone
totalCountinteger(int64)falsenonenone
currentPageinteger(int64)falsenonenone
pageSizeinteger(int64)falsenonenone
totalPageinteger(int64)falsenonenone