v1

latestOpenAPI 3.1.02026-07-246246106.8 KB
Manage your loads

Update a Load

put/loadmanagement/v2/load/{LoadGuid}

Path parameters

LoadGuidstring required

Headers

Content-Typestring
Example:application/json

Request body

loadIdstring
legacyLoadIdstring
postasuserIDstring

(Optional — not recommended) Unique GUID of the user you wish to post the load as, if different from the authenticated user.

For security reasons, we recommend that each user authenticate individually rather than posting on another user's behalf.

Please note: • Loads posted using PostAs cannot be filtered by PostAs within Truckstop.com. • Your integration should always be treated as the source of truth for your loads.

Leave blank to omit this field.

createdBystring
updatedBystring
createdDateTimestring
updatedDateTimestring
tenderIdnumber
carrierNamestring
commodityIdnumber

(Optional) Integer ID of the commodity for this load

Commodities List

notestring

Any publically visible loads notes (0-4000 characters)

freightClassIdnumber
loadNumberstring

Broker specific load identifer

loadTrackingRequiredboolean

Only used for BIN loads, should be false for standard loads

integratorLoadUrlstring nullable

Integrator load URL

distancenumber
LoadLabelstring
tenderNotesstring

These notes are not displayed until the load is booked

loadReferenceNumbersstring[]
carrierTenderGroupIdsnumber[]
isPrivateboolean

Indicates whether the load is private. When true, the load is visible only to your private carrier network. Optionally, provide leadTimeHours to control how many hours before the earliest pickup time a private load transitions to public.

leadTimeHoursnumber nullable

Number of hours before early pickup that private load transitions to public.

waterfallIDstring uuid nullable

(Optional) Allows brokers to post a private load associated with a waterfall.

What is a waterfall? More info here.

Providing a waterfallID will automatically set isPrivate to true. If omitted, the load behaves normally.

carrierListIdsstring[] nullable

List of carrier list IDs (each must be a UUID).

boostedFromstring date-time nullable

UTC timestamp when the current or most recent load boost started.

boostedTostring date-time nullable

UTC timestamp when the current or most recent load boost ends or ended.

Example request

{
  "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"
}

Response

Successful response

loadIdstring
legacyLoadIdstring
postasuserIDstring

(Optional — not recommended) Unique GUID of the user you wish to post the load as, if different from the authenticated user.

For security reasons, we recommend that each user authenticate individually rather than posting on another user's behalf.

Please note: • Loads posted using PostAs cannot be filtered by PostAs within Truckstop.com. • Your integration should always be treated as the source of truth for your loads.

Leave blank to omit this field.

createdBystring
updatedBystring
createdDateTimestring
updatedDateTimestring
tenderIdnumber
carrierNamestring
commodityIdnumber

(Optional) Integer ID of the commodity for this load

Commodities List

notestring

Any publically visible loads notes (0-4000 characters)

freightClassIdnumber
loadNumberstring

Broker specific load identifer

loadTrackingRequiredboolean

Only used for BIN loads, should be false for standard loads

integratorLoadUrlstring nullable

Integrator load URL

distancenumber
LoadLabelstring
tenderNotesstring

These notes are not displayed until the load is booked

loadReferenceNumbersstring[]
carrierTenderGroupIdsnumber[]
isPrivateboolean

Indicates whether the load is private. When true, the load is visible only to your private carrier network. Optionally, provide leadTimeHours to control how many hours before the earliest pickup time a private load transitions to public.

leadTimeHoursnumber nullable

Number of hours before early pickup that private load transitions to public.

waterfallIDstring uuid nullable

(Optional) Allows brokers to post a private load associated with a waterfall.

What is a waterfall? More info here.

Providing a waterfallID will automatically set isPrivate to true. If omitted, the load behaves normally.

carrierListIdsstring[] nullable

List of carrier list IDs (each must be a UUID).

boostedFromstring date-time nullable

UTC timestamp when the current or most recent load boost started.

boostedTostring date-time nullable

UTC timestamp when the current or most recent load boost ends or ended.

Example response

{
  "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"
}