Get a Lane Loads Report

The /v2/lane/reports/get/loads endpoint allows you get a breakdown of loads that you have covered on a particular lane.

For TMS integrators, use this to give your users a list of recent loads to work from when they are at a decision point in your software that is pertinent to this lane.

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
GET

Required parameters

Name
Type
Value(s)
pk
string
Your public API key
sk
string
Your secret API key
zip_a
string
Point A zip code
zip_b
string
Point B zip code

Return values

This endpoint returns an object with the fields loads and status. The loads field is an array containing containing one or more objects, each with the following keys and values.

Key
Type
Value
load_number
string
The load number. This was either generated by BrokerCarrier or by your TMS, depending on which one you used to post the load announcement.
posted
string
The precise date and time that you posted the load announcement.

Example response

{
    "loads": [
        {
            "load_number": "147000152-136",
            "posted": "2022-02-23 13:49:45.761239"
        },
        {
            "load_number": "147000152-135",
            "posted": "2022-02-16 10:25:39.542568"
        },
        {
            "load_number": "147000152-134",
            "posted": "2022-02-16 10:25:16.744026"
        },
        {
            "load_number": "147000152-133",
            "posted": "2022-02-16 10:22:03.770267"
        },
        {
            "load_number": "147000152-132",
            "posted": "2022-02-16 10:21:41.39376"
        }
    ],
    "status": 200
}
        

Start your 30-day free trial of BrokerCarrier today

You'll be up and running in 10 minutes.