# truckstop Documentation ## API Reference - [Obtain a new or refresh existing token](https://developer.truckstop.com/reference/obtain-token-set.md): With REST APIs, there are two different API calls to get tokens. These will be the same for both authentication methods, Resource Owner Password for Proprietary systems and Authentication code flow for 3rd party TMS systems ([more](https://truckstop.readme.io/reference/overview-1)). Depending on your setup, you will use the resource owner grant or authorization code grant type. If you are unsure how your credentials are configured, please email [TSI@Truckstop.com](mailto:TSI@Truckstop.com). - [Token-based Authentication](https://developer.truckstop.com/reference/overview-1.md) - [Get carriers in a broker's network](https://developer.truckstop.com/reference/get-mynetwork.md): Returns the list of carriers in the authenticated broker's network, with support for filtering, searching, sorting, and paging. Callers entitled to advanced risk data will additionally receive the carrier's current compliance status; all other callers will receive a null compliance status for every row. - [Bulk add, update, or remove carriers in a broker's network](https://developer.truckstop.com/reference/manage-mynetwork.md): Performs batched add, update, and remove operations against the authenticated broker's network. Carriers are identified by DOT number only. The request is an array of operation groups; each group specifies an action and the DOT numbers it applies to. The response mirrors that structure and, for each operation group, reports the DOT numbers that were affected as well as the DOT numbers that were skipped along with a per-item reason and code. Each operation result reports DOT numbers in three buckets: `affected` (the action was performed exactly as requested), `adjusted` (the action was performed but altered from what was requested - for example, an Add that would exceed the broker's active-network limit is added to the inactive list instead), and `skipped` (the action was not performed; reason explains why). Semantics: * Add - affected are DOT numbers that were not already in the network and have been added to the active list when `activate` is true or to the inactive list when `activate` is false. Adjusted are DOT numbers that were added but placed differently than requested - currently, this occurs when adding with `activate` true would exceed the broker's active-network limit, in which case the overflow DOTs are added to the inactive list and reported here with reason `OverLimitAddedInactive`. Skipped are DOT numbers already in the network (AddDuplicate), invalid (InvalidDot), or otherwise not added (Other). `activate` is required. * Update - affected are DOT numbers that were in the network and now appear on the active list when `activate` is true or on the inactive list when `activate` is false. A carrier already on the target list is still considered affected. Skipped are DOT numbers not in the network (UpdateNotFound), invalid (InvalidDot), or otherwise not updated (Other). `activate` is required. * Remove - affected are DOT numbers that were in the network and have been removed from it entirely (no longer on either list). Skipped are DOT numbers not in the network (RemoveNotFound), invalid (InvalidDot), or otherwise not removed (Other). `activate` must be omitted or null; supplying a value results in a 400 response. - [Delete a carrier from the BIN Preferred carriers list](https://developer.truckstop.com/reference/delete_companymanagement-v2-carrier-carrierprofileid.md) - [Delete a carrier from a specific Carrier Group](https://developer.truckstop.com/reference/delete_groupmanagement-v2-group-groupid-carrier-carrierprofileid.md) - [Delete a specific Carrier Group](https://developer.truckstop.com/reference/delete_groupmanagement-v2-group-groupid.md) - [Get the details of a carrier](https://developer.truckstop.com/reference/get_companymanagement-v2-carrier-carrierprofileid.md) - [Get the details for fields that can be used in a search query](https://developer.truckstop.com/reference/get_companymanagement-v2-carrier-searchfield.md) - [Get a list of fields that can be used to sort search results](https://developer.truckstop.com/reference/get_companymanagement-v2-carrier-sortfield.md) - [Search for a carrier in the user’s BIN Preferred carrier list](https://developer.truckstop.com/reference/post_companymanagement-v2-carrier-search.md) - [Adds a carrier to the user’s BIN Preferred carrier list](https://developer.truckstop.com/reference/post_companymanagement-v2-carrier.md) - [Search for Carriers within a specific Carrier Group](https://developer.truckstop.com/reference/post_groupmanagement-v2-carrier-search-groupid.md) - [Obtain Carrier group membership](https://developer.truckstop.com/reference/post_groupmanagement-v2-group-carrier-carrierprofileid.md) - [Assigns Carrier(s) to existing Carrier Group](https://developer.truckstop.com/reference/post_groupmanagement-v2-group-groupid-carrier-carrierprofileid.md) - [Bulk Assigns Carriers to existing Carrier Group](https://developer.truckstop.com/reference/post_groupmanagement-v2-group-groupid.md) - [Search for a Broker’s Carrier Groups](https://developer.truckstop.com/reference/post_groupmanagement-v2-group-search.md) - [Creates Carrier Group](https://developer.truckstop.com/reference/post_groupmanagement-v2-group.md) - [Update the details of a carrier](https://developer.truckstop.com/reference/put_companymanagement-v2-carrier-carrierprofileid.md) - [Updates a Carrier Group name](https://developer.truckstop.com/reference/put_groupmanagement-v2-group-groupid.md) - [Book It Now](https://developer.truckstop.com/reference/book-it-now.md): Book It Now is an optional add on to the Load Management API. - [Revoke a tendered load](https://developer.truckstop.com/reference/put_tendering-v1-load-loadid.md) - [Get Booked Loads Details By Load Id](https://developer.truckstop.com/reference/get_tendering-v1-load-loadid.md) - [Get Tender Details By TenderId](https://developer.truckstop.com/reference/get_tendering-v1-tender-tenderid.md) - [Get a CSV file of Booked Loads Overviews](https://developer.truckstop.com/reference/post_tendering-v1-account-tender-overview.md) - [Retrieve Tenders by Account](https://developer.truckstop.com/reference/post_tendering-v2-account.md) - [Deletes a terms and conditions entry](https://developer.truckstop.com/reference/delete_termsandconditions-v1-ratecon-tc-id.md) - [Get the details for fields that can be used in a search query](https://developer.truckstop.com/reference/get_termsandconditions-v1-ratecon-searchfield.md) - [Get a list of fields that can be used to sort search results](https://developer.truckstop.com/reference/get_termsandconditions-v1-ratecon-sortfield.md) - [Get the details for a terms and conditions entry](https://developer.truckstop.com/reference/get_termsandconditions-v1-ratecon-tc-id.md) - [Search for a terms and conditions entry](https://developer.truckstop.com/reference/post_termsandconditions-v1-ratecon-search.md) - [Creates a new terms and conditions entry](https://developer.truckstop.com/reference/post_termsandconditions-v1-ratecon.md) - [Edits a terms and conditions entry](https://developer.truckstop.com/reference/put_termsandconditions-v1-ratecon-tc-id.md) - [Delete a Load](https://developer.truckstop.com/reference/delete-load.md) - [Get details for a specific load](https://developer.truckstop.com/reference/get_loadmanagement-v2-load-loadguid.md) - [Create Load Boost](https://developer.truckstop.com/reference/post_loadmanagement-v2-load-boost.md): Creates a new boost for an existing, active load. Load Boost temporarily promotes a load's visibility to carriers for a fixed 30-minute window. Only one active boost may exist per load at a time. Requires broker-level authorization. - [Post a Load](https://developer.truckstop.com/reference/post-load.md) - [Update Load Boost](https://developer.truckstop.com/reference/put_loadmanagement-v2-load-boost.md): Manually ends an active boost early by setting an unboostedDate. After this call the boost is no longer active. - [Refresh a Load](https://developer.truckstop.com/reference/refresh-load.md) - [Update a Load](https://developer.truckstop.com/reference/update-load.md) - [Overview](https://developer.truckstop.com/reference/load-operations-overview.md) - [Get the available load search criteria fields](https://developer.truckstop.com/reference/get_loadmanagement-v2-load-searchfield.md) - [Get the available load search sort fields](https://developer.truckstop.com/reference/get_loadmanagement-v2-load-sortfield.md) - [Search within your posted loads](https://developer.truckstop.com/reference/post_loadmanagement-v2-load-search.md) - [Get all active user details on the account](https://developer.truckstop.com/reference/post_accountmanagement-v1-accountuser-active.md) - [Deprecation](https://developer.truckstop.com/reference/deprecation.md) - [Limitations & Disclaimers](https://developer.truckstop.com/reference/limitations-disclaimers.md) - [Data Use](https://developer.truckstop.com/reference/storage-policy.md) - [Versioning](https://developer.truckstop.com/reference/versioning-policy.md) - [Best Practices](https://developer.truckstop.com/reference/best-practices.md) - [General API Overview](https://developer.truckstop.com/reference/general-overview.md) - [Getting Test Credentials](https://developer.truckstop.com/reference/getting-test-credentials.md) - [Moving To Production](https://developer.truckstop.com/reference/moving-to-production.md) - [Truckstop Branding and Logos](https://developer.truckstop.com/reference/truckstop-logos.md) - [Booked Rates](https://developer.truckstop.com/reference/booked-rates.md) - [Get the booked 3 year history](https://developer.truckstop.com/reference/post_modeledrate-v3-booked-history-threeyear.md) - [Get the booked rate estimate](https://developer.truckstop.com/reference/post_modeledrate-v3-booked-rateestimate.md) - [Get the booked 4 week trendline](https://developer.truckstop.com/reference/post_modeledrate-v3-booked-trend-fourweek.md) - [Contribute rates data](https://developer.truckstop.com/reference/post_ratecrowdsourcing-v2-rates.md): Submit an array of rated loads to contribute to the accuracy of the predictive model that powers Rate Insights. - [Posted Rates](https://developer.truckstop.com/reference/posted-rates-1.md) - [Get the posted rate estimate](https://developer.truckstop.com/reference/post_modeledrate-v3-posted-rateestimate-1.md) - [Returns the 4 week trendline for a lane](https://developer.truckstop.com/reference/post_modeledrate-v3-posted-trend-fourweek.md) - [Overview](https://developer.truckstop.com/reference/predictive-rate-data.md) - [Dropped Reason Codes](https://developer.truckstop.com/reference/dropped-reason-codes.md) - [Overview](https://developer.truckstop.com/reference/overview-2.md) - [Pause a BIN load](https://developer.truckstop.com/reference/pause-a-bin-load.md): Add description... - [Revoke Reason Codes](https://developer.truckstop.com/reference/revoke-reason-codes.md) - [See if the current user meets the BIN requirements](https://developer.truckstop.com/reference/see-if-the-current-user-meets-the-bin-requirements.md): Add description... - [Unpause a BIN load](https://developer.truckstop.com/reference/unpause-a-bin-load.md): Add description... - [Boost a Load](https://developer.truckstop.com/reference/boost-a-load.md): Temporarily promotes a load's visibility to carriers for a fixed 30-minute window. Cost $1**Try it:** Here - [Delete a load](https://developer.truckstop.com/reference/delete-a-posted-load.md): Removes the specified load from the load board. **Try it:** Here - [Get a posted load by id](https://developer.truckstop.com/reference/get-a-posted-load-by-id.md): **Try it:** Here - [Load Management](https://developer.truckstop.com/reference/load-management-1.md): The purpose of the Load Management API is to help manage the life cycle of loads on the load board. - [Search within your posted loads](https://developer.truckstop.com/reference/pload2.md): **Try it:** Here - [Post a Load](https://developer.truckstop.com/reference/post-a-load.md): This will post a new load to the load board **Try it:** Here - [Refresh a load](https://developer.truckstop.com/reference/refresh-a-load.md): **Try it:** Here - [Update a posted load](https://developer.truckstop.com/reference/update-posted-loads.md): **Try it:** Here - [Update/Stop a Boosted Load](https://developer.truckstop.com/reference/updatestop-a-boosted-load.md): Manually ends an active boost early by setting an unboostedDate. After this call the boost is no longer active.**Try it:** Here - [Booked 36-Month Trendline](https://developer.truckstop.com/reference/booked-36-month-trendline.md) - [Booked Rate Four Week Trendline](https://developer.truckstop.com/reference/booked-rate-four-week-trendline.md) - [Booked Rate Estimate](https://developer.truckstop.com/reference/booked-rates-1.md) - [Rate Insights V3](https://developer.truckstop.com/reference/rate-insights-v3.md) - [Posted Rate Estimate](https://developer.truckstop.com/reference/posted-rate-estimate.md) - [Posted Rate Four Week Trendline](https://developer.truckstop.com/reference/posted-rate-four-week-trendline.md) - [Rate Crowdsourcing](https://developer.truckstop.com/reference/rate-crowdsourcing.md): Rate Crowdsource allows users to submit their rates to Truckstop. - [RMIS: Commodities](https://developer.truckstop.com/reference/commodities-1.md) - [Commodities](https://developer.truckstop.com/reference/commodities.md) - [Equipment Options](https://developer.truckstop.com/reference/equipment-options.md) - [Equipment Types](https://developer.truckstop.com/reference/equipment-types.md) - [Freight Class](https://developer.truckstop.com/reference/freight-class.md) - [Load States and Reason Codes](https://developer.truckstop.com/reference/load-states-and-reason-codes.md) - [RMIS: Modes](https://developer.truckstop.com/reference/modes.md) - [RMIS: Operating Areas](https://developer.truckstop.com/reference/operating-areas.md) - [Rates](https://developer.truckstop.com/reference/rates.md) - [Risk Factors Subcategories](https://developer.truckstop.com/reference/risk-factors-subcategories-1.md) - [RMIS: ELD Fleet Location](https://developer.truckstop.com/reference/rmis-eld-fleet-location.md) - [RMIS: ELD Vehicle Location](https://developer.truckstop.com/reference/rmis-eld-vehicle-location.md) - [Transportation Modes](https://developer.truckstop.com/reference/transportation-modes.md) - [waterfallID](https://developer.truckstop.com/reference/waterfallid.md): This optional field allows brokers to post a private load associated with a waterfall. - [Delta API](https://developer.truckstop.com/reference/delta-api-1.md): ### Note: This API is required as part of the integration. **Try it:** Here - [Document API](https://developer.truckstop.com/reference/document-api.md): **Try it:** Here - [ELD - Fleet Location Lookup](https://developer.truckstop.com/reference/eld-fleet-lookup.md): **Try it:** Here - [ELD - Vehicle Location Lookup](https://developer.truckstop.com/reference/eld-vehicle-location-lookup.md): **Try it:** Here - [Expanded Carrier API - Calling the API](https://developer.truckstop.com/reference/expanded-carrier-api-1.md): ### Note: This API is required as part of the integration **Try it:** Here - [Expanded Carrier API - Detail of results](https://developer.truckstop.com/reference/expanded-carrier-api-detail-of-results.md): **Try it:** Here - [Invitation API](https://developer.truckstop.com/reference/invitation-api.md): **Try it:** Here - [Non-Attached Carrier API](https://developer.truckstop.com/reference/non-attached-carrier-api.md): **Try it:** Here - [Registration Steps API](https://developer.truckstop.com/reference/registration-steps-api.md): **Try it:** Here - [LoadManagement.py](https://developer.truckstop.com/reference/loadmanagementpy.md) - [RateInsights.py](https://developer.truckstop.com/reference/rateinsightspy.md) - [RiskFactor.py](https://developer.truckstop.com/reference/riskfactorpy.md) - [RMISDelta.py](https://developer.truckstop.com/reference/rmisdeltapy.md) - [DocumentAPI.py](https://developer.truckstop.com/reference/rmisdocumentpy.md) - [RMISLibrary.py](https://developer.truckstop.com/reference/rmislibrarypy.md) - [TruckstopLibrary.Load.py](https://developer.truckstop.com/reference/truckstop-load-object-python.md) - [TruckstopAuth.py](https://developer.truckstop.com/reference/truckstopauthpy.md) - [TruckstopDataMaps.py](https://developer.truckstop.com/reference/truckstopdatamapspy.md) - [TruckstopDBHelper.py](https://developer.truckstop.com/reference/truckstopdbhelperpy.md) - [Hot Prospects](https://developer.truckstop.com/reference/hot-prospects-1.md) - [Load Search Data Classes](https://developer.truckstop.com/reference/load-search-data-classes.md) - [Truck Searching Data Classes](https://developer.truckstop.com/reference/truck-searching-data-classes.md) - [Truck Posting Data Classes](https://developer.truckstop.com/reference/truckpostingrequest.md) - [Query the RMIS certification status of a given carrier DOT](https://developer.truckstop.com/reference/get_riskfactoranalysis-v1-carriers-dotnumber-certification.md): For RMIS customers, return the certification status of a given carrier according to the business rules as configured in their RMIS instance. Returns true/false or not found if a given carrier is not part of the existing carrier network. This relies on the authentication token of the user making the request. - [Retrieve a single risk analysis report](https://developer.truckstop.com/reference/get_riskfactoranalysis-v1-carriers-identifier-1.md): Retrieves a single report matching the provided MC/DOT number in the route. MC numbers must be in the format "MC#####" and DOT numbers in the format "####". The number of numeric digits can vary. - [Search by identifier from url parameter](https://developer.truckstop.com/reference/get_riskfactoranalysis-v1-carriers-search-1.md): Search by either email or phone number to retrieve an array of zero or more DOT numbers which include that identifier in the risk report. If both the email and phone query parameters are present, only email will be searched. - [Retrieve multiple full risk factor analysis reports](https://developer.truckstop.com/reference/post_riskfactoranalysis-v1-carriers.md): Retrieves multiple reports for each MC/DOT number provided in the payload if a report exists. MC numbers must be in the format "MC#####" and DOT numbers in the format "####". The number of numeric digits can vary. - [Overview](https://developer.truckstop.com/reference/risk-factor-overview.md) - [Attach or Remove a Carrier from Your Monitored Carrier List](https://developer.truckstop.com/reference/attachordetachcarrier.md): Manages whether a carrier is in your monitored carrier list (NOTE - Attach should ONLY be used for testing, not in production) - [Check Carrier Registration Progress](https://developer.truckstop.com/reference/checkcarrierregistrationprogress.md): Check the past 24 hours for registration steps - [Check a Carrier That Is Not Being Monitored](https://developer.truckstop.com/reference/checkunmonitoredcarrier.md): Retrieves basic information regarding a carrier including whether they will pass the set business rules - [Get Carrier Details](https://developer.truckstop.com/reference/getcarrierdetails.md): Retrieve all information regarding a carrier - [Get Carrier ELD Fleet Vehicle Locations](https://developer.truckstop.com/reference/getcarriereldfleetvehiclelocations.md): Retrieves fleet vehicle locations for a carrier by DOT number - [Get Latest ELD Vehicle Location by VIN](https://developer.truckstop.com/reference/getlatesteldvehiclelocationbyvin.md): Retrieves the latest ELD vehicle location for a specific vehicle in a carrier fleet using its VIN - [Invite A Carrier To Register With You](https://developer.truckstop.com/reference/invitecarriertoregister.md): Invite a carrier to join your network - [Manage carrier change queue](https://developer.truckstop.com/reference/managecarrierchangequeue.md): Retrieves a list of carrier RMIS IDs for processing - [Manually Register A Carrier (Skips Onboarding)](https://developer.truckstop.com/reference/registercarrier.md): Onboard a new carrier - [Retrieve Carrier Documents](https://developer.truckstop.com/reference/retrievecarrierdocuments.md): Retrieves base64 encoded document data that can be converted back into the original document format - [Overview](https://developer.truckstop.com/reference/rmis-overview.md) - [View load details](https://developer.truckstop.com/reference/get-load-search-detail-result.md) - [Search for loads](https://developer.truckstop.com/reference/get-load-search-results-1.md) - [View load details for multiple loads](https://developer.truckstop.com/reference/get-multiple-load-detail-results.md): This API call is recommended as this combines the results from both the GetLoadSearchResults and GetLoadSearchDetailResults using fewer API calls. - [Search All Loads](https://developer.truckstop.com/reference/load-search-soap.md): Load Searching makes it possible for Broker/Shippers to find available loads on the Truckstop load board. - [Overview](https://developer.truckstop.com/reference/overview.md) - [Delete a truck by ID](https://developer.truckstop.com/reference/delete-by-truck-number-copy.md) - [Delete a truck by internal number](https://developer.truckstop.com/reference/delete-by-truck-number.md) - [View my truck's details](https://developer.truckstop.com/reference/get-details-of-a-truck.md) - [Search for all my posted trucks](https://developer.truckstop.com/reference/get-my-posted-trucks.md) - [Post My Trucks](https://developer.truckstop.com/reference/truck-post.md) - [Post a truck](https://developer.truckstop.com/reference/post-a-truck.md) - [View details for multiple trucks](https://developer.truckstop.com/reference/get-multiple-truck-details-results.md) - [Search for hidden capacity (Hot Prospects)](https://developer.truckstop.com/reference/get-search-results.md) - [View truck details](https://developer.truckstop.com/reference/get-truck-detail-results.md) - [Search for trucks](https://developer.truckstop.com/reference/get-truck-search-results.md) - [Search All Trucks](https://developer.truckstop.com/reference/truck-search.md) ## Recipes - [Automatically rate and post a load with a margin](https://developer.truckstop.com/recipes/automatically-rate-and-post-a-load-with-a-margin-1.md) - [Get rates for a CSV file of loads](https://developer.truckstop.com/recipes/get-rates-for-a-csv-file-of-loads-1.md) - [How To Exchange an Authorization Code for Access/Refresh Tokens](https://developer.truckstop.com/recipes/how-to-exchange-an-authorization-code-for-accessrefresh-tokens.md) - [How To Obtain an Authorization Code](https://developer.truckstop.com/recipes/how-to-obtain-an-authorization-code.md) - [How To Post a load](https://developer.truckstop.com/recipes/how-to-post-a-load.md) - [How To Refresh an Expired Access Token](https://developer.truckstop.com/recipes/how-to-refresh-an-expired-access-token.md) - [Manage loads on the loadboard](https://developer.truckstop.com/recipes/manage-loads-on-the-loadboard.md) - [Manage onboarded carrier documents](https://developer.truckstop.com/recipes/manage-onboarded-carrier-documents-1.md) - [Manage REST API user tokens (Resource Owner Flow)](https://developer.truckstop.com/recipes/manage-rest-api-user-tokens-resource-owner-flow-1.md) - [Monitoring carriers in RMIS](https://developer.truckstop.com/recipes/monitoring-carriers-in-rmis-1.md) - [Submit booked rates via CSV file](https://developer.truckstop.com/recipes/submit-booked-rates-via-csv-file.md) - [Understand comprehensive risk for carriers](https://developer.truckstop.com/recipes/understand-comprehensive-risk-for-carriers.md)