API Reference

Update a Load

put
https://api-int.truckstop.com/loadmanagement/v2/load/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requestsā€¦
LoadingLoadingā€¦
šŸš§

Note: This operation requires that ALL fields are submitted for updating a load. Values not supplied will be overwritten as null

Path Params
string
required
Body Params

JSON payload containing the load details

string

(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.

postAsUser
object
loadState
object
loadStateReason
object
loadActivity
object
equipmentAttributes
object
number

(Optional) Integer ID of the commodity for this load

Commodities List

loadStops
array of objects
length ā‰„ 2

(Required -- Min 2, max 20) Array of LoadStop objects

loadStops
string

Any publically visible loads notes (0-4000 characters)

number
string

Broker specific load identifer

boolean

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

string | null

Integrator load URL

rateAttributes
object

Posted All In Rate is for standard loads
Tender All In Rate is for BIN loads

customData
array of objects
customData
Dimensional
object
LoadActionAttributes
object

4 - PostOnly is for standard loads
1 - PostOnlineTender is for BIN loads

string
string

These notes are not displayed until the load is booked

loadReferenceNumbers
array of strings
loadReferenceNumbers
termsAndConditions
object
boolean

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.

number | null

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

uuid | null

(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.

carrierListIds
array of uuids | null

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

carrierListIds
Response

Updated about 1 month ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoadingā€¦
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?