API V3 – Fetch the Full Details of a Load

The /v3/loads/fetch/details endpoint lets you retrieve the complete details of 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 load’s complete details can be fetched quickly from BrokerCarrier with just the load number.

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:

  1. 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

Method
URL
GET

Required parameters

Name
Type
Value(s)
pk
string
Your public API key
sk
string
Your secret API key
email
string
Email address of the VETCarriers 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.

Return values

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

Key
Type
Value
details
object
{}
An object with the following fields:

{
object
string
object
object
string
object
string
object
array
array
object
object
string
object
}
notified_carriers
array
[]
An array of up to 200 objects, each with the following fields:

{
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.
response
object
{}
An object with the following fields:

{
string
integer
integer
}

Example response

{
    "details": {
        "created": {
            "date_time": "2022-11-28 19:18:23.625189 UTC",
            "contact": {
                "name": "JANE AGENT",
                "email": "jane@demobroker.com",
                "phone": "5558675309"
            }
        },
        "load_number": "DFG98D7FG97DF9G87A",
        "origin": {
            "city": "LOS ANGELES",
            "state": "CA",
            "zip": "90058",
            "full": "LOS ANGELES, CA 90058"
        },
        "destination": {
            "city": "SPARKS",
            "state": "NV",
            "zip": "89436",
            "full": "SPARKS, NV 89436"
        },
        "distance": "484",
        "rate": {
            "total": "2350",
            "per_mile": "4.86"
        },
        "type": "full",
        "cargo": {
            "weight": "1300",
            "length": "5.5",
            "width": "3.75",
            "commodity": "3d printer resin"
        },
        "equipment": [
            "box_truck",
            "cargo_van",
            "sprinter_van"
        ],
        "services": [
            "expedited",
            "pallet_exchange",
            "gps"
        ],
        "pickup": {
            "earliest": "2022-12-01",
            "latest": "2022-12-02"
        },
        "delivery": {
            "earliest": "2022-12-03",
            "latest": "2022-12-04"
        },
        "notes": null,
        "covered_by": {
            "business_name": "AWESOME CARRIER INC",
            "dot_num": "9876543",
            "mc_num": "987654"
        }
    },
    "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.
        
    ],
    "response": {
        "date_time": "2022-11-28 21:40:49 UTC",
        "timestamp": 1669671649,
        "status": 200
    }
}