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
POSTRequired parameters
pkstringskstringemailstringload_numberstringcarrier_id_typestringcarrier_id_numberstringReturn values
This endpoint returns an object with the following keys and values.
coverageobject{}{
string}
This is merely a verification field that returns the DOT number of the carrier who has covered the load.
responseobject{}{
stringintegerinteger}
Example response
{
"coverage": {
"carrier": "9876543"
},
"response": {
"date_time": "2022-11-28 20:13:21 UTC",
"timestamp": 1669666401,
"status": 200
}
}
