GET
/
api
/
v1
/
loads
curl --request GET \
     --url 'https://api.example.com/api/v1/loads?origin_lat=41.8781&origin_lng=-87.6298&origin_radius=50&destination_lat=40.7128&destination_lng=-74.0060&destination_radius=25' \
     --header 'Authorization: Bearer API_KEY'

{
  "status": 200,
  "loads": [
    {
      "reference_number": "LOAD123",
      "contact": {
        "name": "John Doe",
        "email": "john@example.com",
        "phone": "15552220123",
        "extension": "123",
        "type": "Sales Rep"
      },
      "type": "can-get",
      "stops": [
        {
          "type": "Pick",
          "location": {
            "city": "Chicago",
            "state": "IL",
            "zip_code": "60601",
            "country": "USA"
          },
          "stop_timestamp_open": "2024-03-20T14:00:00Z",
          "stop_timestamp_close": "2024-03-20T16:00:00Z",
        },
        {
          "type": "Drop",
          "location": {
            "city": "New York",
            "state": "NY",
            "zip_code": "10001",
            "country": "USA"
          },
          "stop_timestamp_open": "2024-03-21T14:00:00Z",
          "stop_timestamp_close": "2024-03-21T16:00:00Z",
        }
      ],
      "equipment_type": {
        "name": "Dry Van",
      },
      "max_buy": 1500.50,
      "status": "Available",
      "is_partial": false,
      "posted_carrier_rate": 1200.00,
      "weight": 40000,
      "number_of_pieces": 100,
      "commodity_type": "Automobile Parts",
      "sale_notes": "This is a test load",
      "branch": "Chicago",
      "dimensions": "53 Feet",
      "miles": 500
    }
  ]
}

Search for loads using optional filter parameters. Returns a list of matching loads. Depending on the use case, you may need to implement different filters, not all of these are required for everyone.

​
Query Parameters

​
origin_city
string

Filter by origin city

​
origin_state
string

Filter by origin state

​
destination_city
string

Filter by destination city

​
destination_state
string

Filter by destination state

​
equipment_type
string

Filter by equipment type name

​
reefer_min_temp
number

Filter Reefer loads by the minimum allowed temperature

​
reefer_max_temp
number

Filter Reefer loads by the maximum allowed temperature

​
pickup_date
string

Filter by pickup date (ISO 8601 format)

​
origin_lat
number

Latitude coordinate for the origin location (in decimal degrees)

​
origin_lng
number

Longitude coordinate for the origin location (in decimal degrees)

​
origin_radius
number

Search radius (in miles) from the origin coordinates

​
destination_lat
number

Latitude coordinate for the destination location (in decimal degrees)

​
destination_lng
number

Longitude coordinate for the destination location (in decimal degrees)

​
destination_radius
number

Search radius (in miles) from the destination coordinates

​
Status Codes

​
200
number

Successfully retrieved the list of loads

​
500
number

Internal server error

​
Response

​
loads
array

List of loads matching the search criteria

curl --request GET \
     --url 'https://api.example.com/api/v1/loads?origin_lat=41.8781&origin_lng=-87.6298&origin_radius=50&destination_lat=40.7128&destination_lng=-74.0060&destination_radius=25' \
     --header 'Authorization: Bearer API_KEY'

{
  "status": 200,
  "loads": [
    {
      "reference_number": "LOAD123",
      "contact": {
        "name": "John Doe",
        "email": "john@example.com",
        "phone": "15552220123",
        "extension": "123",
        "type": "Sales Rep"
      },
      "type": "can-get",
      "stops": [
        {
          "type": "Pick",
          "location": {
            "city": "Chicago",
            "state": "IL",
            "zip_code": "60601",
            "country": "USA"
          },
          "stop_timestamp_open": "2024-03-20T14:00:00Z",
          "stop_timestamp_close": "2024-03-20T16:00:00Z",
        },
        {
          "type": "Drop",
          "location": {
            "city": "New York",
            "state": "NY",
            "zip_code": "10001",
            "country": "USA"
          },
          "stop_timestamp_open": "2024-03-21T14:00:00Z",
          "stop_timestamp_close": "2024-03-21T16:00:00Z",
        }
      ],
      "equipment_type": {
        "name": "Dry Van",
      },
      "max_buy": 1500.50,
      "status": "Available",
      "is_partial": false,
      "posted_carrier_rate": 1200.00,
      "weight": 40000,
      "number_of_pieces": 100,
      "commodity_type": "Automobile Parts",
      "sale_notes": "This is a test load",
      "branch": "Chicago",
      "dimensions": "53 Feet",
      "miles": 500
    }
  ]
}

Was this page helpful?

Load EventGet Load