v1

latestOpenAPI 3.1.02026-07-246246106.8 KB
Manage your loads

Search within your posted loads

post/loadmanagement/v2/load/search

Request body

Example request

{
  "pagination": {
    "pageNumber": 1,
    "pageSize": 100
  },
  "searchCriteria": [
    {
      "name": "LoadActionId",
      "operator": "eq"
    }
  ],
  "sortCriteria": [
    {
      "direction": "descending",
      "name": "OriginCity"
    }
  ]
}

Response

Successful response

Example response

{
  "pagination": {
    "totalPages": 1,
    "pageNumber": 1,
    "pageSize": 100,
    "totalItemCount": 1
  },
  "data": [
    {
      "loadId": "a020197d-511c-4370-aa8d-2b6172fecc4c",
      "legacyLoadId": "null",
      "postasuserID": "df7dbc1a-a21d-e911-a9ec-a3b8a698ca96",
      "postAsUser": {
        "id": "df7dbc1a-a21d-e911-a9ec-a3b8a698ca96",
        "firstName": "Tom",
        "lastName": "Jerry",
        "email": "tomjerry@truckstop.com",
        "phone": "(123) 456-7890",
        "userName": "TOMJERRY"
      },
      "createdBy": "df7dbc1a-a21d-e911-a9ec-a3b8a698ca96",
      "updatedBy": "null",
      "createdDateTime": "2024-09-23T15:34:33",
      "updatedDateTime": "2024-09-23T15:34:33",
      "loadState": {
        "loadStateDescription": "Posted",
        "loadStateId": 1
      },
      "loadStateReason": {
        "loadStateReasonDescription": "Not Specified"
      },
      "carrierName": "null",
      "loadActivity": {
        "id": "cc6f6efc-f111-4eaf-7a7d-08dcd8c75967",
        "createdDate": "2024-09-23T15:34:33",
        "loadState": {
          "loadStateDescription": "Posted",
          "loadStateId": 1
        },
        "loadStateReason": {
          "loadStateReasonDescription": "Not Specified"
        },
        "comment": "null"
      },
      "equipmentAttributes": {
        "equipmentTypeId": 17,
        "equipmentOptions": [
          2
        ],
        "transportationModeId": 2,
        "otherEquipmentNeeds": "Pallet Return"
      },
      "commodityId": 1,
      "loadStops": [
        {
          "type": 1,
          "sequence": 1,
          "earlyDateTime": "2024-09-24T11:00:00",
          "lateDateTime": "2024-09-24T11:00:00",
          "location": {
            "locationName": "Shipper",
            "city": "Chicago",
            "state": "IL",
            "streetAddress1": "123 Main St",
            "streetAddress2": null,
            "countryCode": "USA",
            "postalCode": 60007,
            "latitude": 41.8781,
            "longitude": -87.6298
          },
          "contactName": "Joseph Smith",
          "contactPhone": 1234567890,
          "stopNotes": "Pickup"
        },
        {
          "type": 2,
          "sequence": 2,
          "earlyDateTime": "2024-09-24T11:00:00",
          "lateDateTime": "2024-09-24T11:00:00",
          "location": {
            "locationName": "Receiver",
            "city": "Chicago",
            "state": "IL",
            "streetAddress1": "321 Main St",
            "streetAddress2": null,
            "countryCode": "USA",
            "postalCode": 60007,
            "latitude": 41.8781,
            "longitude": -87.6298
          },
          "contactName": "Joseph Smith",
          "contactPhone": 1234567890,
          "stopNotes": "Drop Off"
        }
      ],
      "note": "Important Load Info",
      "freightClassId": 1,
      "loadNumber": "Load123-456",
      "rateAttributes": {
        "postedAllInRate": {
          "amount": 123.45,
          "currencyCode": "USD"
        },
        "tenderAllInRate": {
          "amount": 123.45,
          "currencyCode": "USD"
        }
      },
      "customData": [
        {
          "key": "My_Custom_Field",
          "value": "My_Custom_Value"
        }
      ],
      "distance": 123,
      "Dimensional": {
        "length": 53,
        "width": 8,
        "height": 10,
        "weight": 40000,
        "palletCount": 5,
        "pieceCount": 500,
        "cube": 4240
      },
      "LoadActionAttributes": {
        "loadActionOption": "PostOnly"
      },
      "LoadLabel": "Boxes of screws",
      "tenderNotes": "Notes shown after booking",
      "termsAndConditions": {
        "id": "1234-56789-0123456",
        "name": "My T&C"
      },
      "boostedFrom": "2026-03-03T15:13:03.319Z",
      "boostedTo": "2026-03-03T15:13:03.319Z"
    }
  ]
}