Mark a Load Covered

The /v2/load/announcements/mark/covered endpoint lets you mark a load announcement as covered and keep track of which carrier covered it. This improves the quality of your load notifications by keeping up-to-date maps of your lane coverage.

For TMS integrators, call this endpoint when your user closes out a load in your software. Our API will accept any load number format, so there is no need to create a second identifier other than the load number that your software generates when the load is created.

This endpoint must be called from the server side to avoid compromising your secret API key. Do not use your secret key in client-side JavaScript.

HTTP request

Method
URL
POST

Required parameters

Name
Type
Value(s)
pk
string
Your public API key
sk
string
Your secret API key
carrier_id_type
string
One of:




carrier_id_number
string
A properly formatted MC number, DOT number, SCAC, or CBSA code
load_number
string
The unique load ID number. Our API will accept the load numbers that are generated by your TMS.

Return values

This endpoint returns an object with the following keys and values.

Key
Type
Value
load_number
string
The load number, as formatted in the API call

Example response

{
    "load_number": "147000152-136",
    "status": 200
}
        

Start your 30-day free trial of BrokerCarrier today

You'll be up and running in 10 minutes.