The /v3/loads/fetch/notified/carriers
endpoint lets you retrieve the list of carriers who were notified about a load that was announced through BrokerCarrier’s Load Announcements tool.
For TMS integrators, this endpoint is most useful for screens where the broker can review the details of a saved load record, whether that load is still open or has been covered. The notified carriers list can be fetched quickly from BrokerCarrier with just the load number.
This endpoint serves as an alternate to the /v3/loads/fetch/details
endpoint, for scenarios when you already have the complete load details stored in your system.
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 already generates when the load tender 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.
HTTP request
GET
Required parameters
pk
string
sk
string
email
string
load_number
string
Return values
This endpoint returns an object with the following keys and values.
carriers
array
[]
{
string
string
string
string
string
string
}
Of note, the
reason
field refers to the reason why the carrier was selected to be notified about the load.
load_number
string
response
object
{}
{
string
integer
integer
}
Example response
{ "notified_carriers": [ { "business_name": "AWESOME CARRIER INC", "dot_num": "9876543", "docket_num": "987654", "phone": "5558675310", "email": "dispatch@awesomecarrier.com", "reason": "Previously covered this lane." }, { "business_name": "ALSO AWESOME CARRIER LLC", "dot_num": "8765432", "docket_num": "876543", "phone": "5558675311", "email": "dispatch@alsoawesomecarrier.com", "reason": "Lists this exact lane in lane preferences." } # This array will contain up to 200 objects like the above. ], "load_number": "DFG98D7FG97DF9G87A", "response": { "date_time": "2022-11-28 21:40:49 UTC", "timestamp": 1669671649, "status": 200 } }