For AI agents: visit https://developer.truckstop.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
truckstop
HomeRecipesAPI Reference
v1.0

Log Intruckstop
API Reference
Log In
v1.0HomeRecipesAPI Reference

Quick Start

  • General API Overview
  • Best Practices
  • Getting Test Credentials
  • Moving To Production
  • Truckstop Branding and Logos

Authentication

  • Token-based Authentication
  • Obtain a new or refresh existing tokenpost

Load Management

  • Overview
  • Manage your loads
    • Post a Loadpost
    • 🔥Create Load Boostpost
    • Update a Loadput
    • Update Load Boostput
    • Delete a Loaddel
    • Get details for a specific loadget
    • Refresh a Loadpost
  • Search within your loads
    • Search within your posted loadspost
    • Get the available load search criteria fieldsget
    • Get the available load search sort fieldsget
  • User Management
    • Get all active user details on the accountpost
  • Book It Now
    • Terms and Conditions
      • Creates a new terms and conditions entrypost
      • Get the details for a terms and conditions entryget
      • Edits a terms and conditions entryput
      • Deletes a terms and conditions entrydel
      • Search for a terms and conditions entrypost
      • Get the details for fields that can be used in a search queryget
      • Get a list of fields that can be used to sort search resultsget
    • Tendering
      • Retrieve Tenders by Accountpost
      • Get Booked Loads Details By Load Idget
      • Get Tender Details By TenderIdget
      • Get a CSV file of Booked Loads Overviewspost
    • Carrier Management
      • Adds a carrier to the user’s BIN Preferred carrier listpost
      • Delete a carrier from the BIN Preferred carriers listdel
      • Get the details of a carrierget
      • Update the details of a carrierput
      • Search for a carrier in the user’s BIN Preferred carrier listpost
      • Get the details for fields that can be used in a search queryget
      • Get a list of fields that can be used to sort search resultsget
      • Carrier Groups
      • Creates Carrier Grouppost
      • Updates a Carrier Group nameput
      • Delete a specific Carrier Groupdel
      • Bulk Assigns Carriers to existing Carrier Grouppost
      • Assigns Carrier(s) to existing Carrier Grouppost
      • Delete a carrier from a specific Carrier Groupdel
      • Obtain Carrier group membershippost
      • Search for a Broker’s Carrier Groupspost
      • Search for Carriers within a specific Carrier Grouppost
    • Revoke a tendered loadput

Carrier Network Management

  • Carrier Hub
    • Get carriers in a broker's networkget
    • Bulk add, update, or remove carriers in a broker's networkpost

RMIS - Carrier Compliance Monitoring

  • Overview
  • Onboard/Monitor Carriers
    • Manage carrier change queuepost
    • Get Carrier Detailsget
    • Check a Carrier That Is Not Being Monitoredget
    • Retrieve Carrier Documentsget
    • Invite A Carrier To Register With Youpost
    • Manually Register A Carrier (Skips Onboarding)post
    • Check Carrier Registration Progresspost
    • Attach or Remove a Carrier from Your Monitored Carrier Listget
    • Get Carrier ELD Fleet Vehicle Locationsget
    • Get Latest ELD Vehicle Location by VINget

Rate Insights

  • Overview
  • Contribute rates datapost
  • Booked Rates
    • Get the booked rate estimatepost
    • Get the booked 4 week trendlinepost
    • Get the booked 3 year historypost
  • Posted Rates
    • Get the posted rate estimatepost
    • Returns the 4 week trendline for a lanepost

SOAP APIs

  • Overview
  • Search All Loads
    • Search for loads
    • View load details
    • View load details for multiple loads
  • Post My Trucks
    • Post a truck
    • Search for all my posted trucks
    • View my truck's details
    • Delete a truck by ID
    • Delete a truck by internal number
  • Search All Trucks
    • View details for multiple trucks
    • Search for trucks
    • Search for hidden capacity (Hot Prospects)
    • View truck details

Notices

  • Limitations & Disclaimers
  • Versioning
  • Deprecation
  • Data Use

REFERENCE

  • Load Management
    • Post a Load
    • Delete a load
    • Get a posted load by id
    • Update a posted load
    • Search within your posted loads
    • Refresh a load
    • Boost a Load
    • Update/Stop a Boosted Load
  • Book It Now (BIN)
    • Overview
    • See if the current user meets the BIN requirements
    • Pause a BIN load
    • Unpause a BIN load
    • Revoke Reason Codes
    • Dropped Reason Codes
  • Rate Insights V3
    • Booked Rate Estimate
    • Booked Rate Four Week Trendline
    • Booked 36-Month Trendline
    • Posted Rate Estimate
    • Posted Rate Four Week Trendline
    • Rate Crowdsourcing
  • RMIS
    • Delta API
    • Expanded Carrier API - Calling the API
    • Expanded Carrier API - Detail of results
    • Document API
    • Non-Attached Carrier API
    • Invitation API
    • Registration Steps API
    • ELD - Fleet Location Lookup
    • ELD - Vehicle Location Lookup
  • Reference Tables
    • RMIS: Operating Areas
    • RMIS: Commodities
    • RMIS: Modes
    • RMIS: ELD Vehicle Location
    • RMIS: ELD Fleet Location
    • Load States and Reason Codes
    • Freight Class
    • Commodities
    • Transportation Modes
    • Equipment Options
    • Equipment Types
    • Rates
    • Risk Factors Subcategories
    • waterfallID
  • Script Reference
    • TruckstopAuth.py
    • LoadManagement.py
    • TruckstopLibrary.Load.py
    • RateInsights.py
    • RMISDelta.py
    • DocumentAPI.py
    • RMISLibrary.py
    • TruckstopDBHelper.py
    • TruckstopDataMaps.py
    • RiskFactor.py
  • SOAP Reference Tables
    • Truck Searching Data Classes
    • Truck Posting Data Classes
    • Load Search Data Classes
    • Hot Prospects

Risk Factor Analysis

  • Analyze Carrier Risk
    • Overview
    • Retrieve a single risk analysis reportget
    • Search by identifier from url parameterget
    • Query the RMIS certification status of a given carrier DOTget
    • Retrieve multiple full risk factor analysis reportspost
Powered by 

Carrier Groups

Updated about 1 year ago


Get a list of fields that can be used to sort search results
Creates Carrier Group
Did this page help you?

Updated about 1 year ago


Get a list of fields that can be used to sort search results
Creates Carrier Group
Did this page help you?