The /v4/lanes/load/from/carriers/ endpoint lets you retrieve the index of lane preferences that have been specified by your onboarded carriers.
Notes on this endpoint:
- Potential for large responses. This endpoint can potentially return very large responses. For this reason, we recommend handling requests to this endpoint asynchronously.
- Authentication via header. To authenticate your API call, pass in your public API key with the X-Api-Key HTTP header.
HTTP Request
| Method | URL |
|---|---|
| GET | https://api.brokercarrier.com/v4/lanes/load/from/carrier |
Required Parameters
None.
Example Response
Request: https://api.brokercarrier.com/v4/lanes/load/from/carrier
The example response below shows a list containing five carrier-specified lane preferences. Your real API calls will return much larger responses than this.
[
{
"carriers": 58,
"distance": 258.78,
"duration": 244.29,
"stops": {
"origin": "HOUSTON, TX",
"destination": "DALLAS, TX"
}
},
{
"carriers": 28,
"distance": 448.94,
"duration": 424.77,
"stops": {
"origin": "HOUSTON, TX",
"destination": "OKLAHOMA CITY, OK"
}
},
{
"carriers": 24,
"distance": 259.16,
"duration": 244.28,
"stops": {
"origin": "DALLAS, TX",
"destination": "HOUSTON, TX"
}
},
{
"carriers": 21,
"distance": 183.55,
"duration": 194.25,
"stops": {
"origin": "CHICAGO, IL",
"destination": "INDIANAPOLIS, IN"
}
},
{
"carriers": 20,
"distance": 1103.94,
"duration": 1078.05,
"stops": {
"origin": "CHICAGO, IL",
"destination": "HOUSTON, TX"
}
}
]