Knowledge Base | API Documentation | API V3 – Mark a Load as Covered

API V3 – Mark a Load as Covered

The /v3/loads/mark/covered endpoint lets you mark a load 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, this endpoint is useful when the broker closes out a load in your software. By calling this endpoint and marking the load as covered in BrokerCarrier, you help to ensure that our mutual customer gets continuously better carrier matches every time they post a load on this lane or any nearby lane.

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.

Notes on this endpoint:

Requires secret key. This endpoint must be called from the server side to avoid compromising your secret API key. Please do not use your secret key in client-side JavaScript.
Carrier must be in-network for the broker. In order to select a carrier as the one who covered a load, they must be onboarded into the broker’s network via BrokerCarrier.

HTTP request

Method

URL

POST

Required parameters

Name

Type

Value(s)

pk

string

Your public API key

sk

string

Your secret API key

email

string

Email address of the BrokerCarrier user who is making the API call

load_number

string

Our API will accept the load numbers that are generated by your TMS or integrated app. The only requirement is that it is passed in string format.

carrier_id_type

string

One of:

carrier_id_number

string

A properly formatted DOT number or MC number

Return values

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

Key

Type

Value

coverage

object
{}

An object with the following fields:

{
string
}

This is merely a verification field that returns the DOT number of the carrier who has covered the load.

response

object
{}

An object with the following fields:

{
string
integer
integer
}

Example response

{
    "coverage": {
        "carrier": "9876543"
    },
    "response": {
        "date_time": "2022-11-28 20:13:21 UTC",
        "timestamp": 1669666401,
        "status": 200
    }
}

API V3 – Mark a Load as Covered

Notes on this endpoint:

HTTP request

Required parameters

Return values

Example response

Start Your 30-Day Free Trial Today

It's time to put your carrier sales on autopilot and get better load coverage with BrokerCarrier. Setting up your account is a breeze.