Get Load

curl --request GET \
     --url 'https://api.example.com/api/v1/loads/LOAD123' \
     --header 'Authorization: Bearer API_KEY'

{
  "statusCode": 200,
  "body": {
    "load": {
    "reference_number": "LOAD123",
    "contact": {
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "15552220123",
      "extension": "123",
      "type": "assigned"
    },
    "type": "owned",
    "stops": [
      {
        "type": "origin",
        "location": {
          "city": "Chicago",
          "state": "IL",
          "zip": "60601",
          "country": "US"
        },
        "stop_timestamp_open": "2024-03-20T14:00:00",
        "stop_timestamp_close": "2024-03-20T16:00:00"
      },
      {
        "type": "destination",
        "location": {
          "city": "New York",
          "state": "NY",
          "zip": "10001",
          "country": "US"
        },
        "stop_timestamp_open": "2024-03-21T14:00:00",
        "stop_timestamp_close": "2024-03-21T16:00:00"
      }
    ],
    "equipment_type": "Dry Van",
    "max_buy": 1500.50,
    "status": "available",
    "is_partial": false,
    "is_hazmat": false,
    "posted_carrier_rate": 1200.00,
    "weight": 40000,
    "number_of_pieces": 100,
    "commodity_type": "Automobile Parts",
    "sale_notes": "This is a test load",
    "dimensions": "53 Feet",
    "branch": "Chicago",
    "miles": 500,
    "bridge": {
      "status": "success",
      "bridge_load_id": "BRK-456789"
    }
    }
  }
}

GET

api

loads

{load_id}

curl --request GET \
     --url 'https://api.example.com/api/v1/loads/LOAD123' \
     --header 'Authorization: Bearer API_KEY'

{
  "statusCode": 200,
  "body": {
    "load": {
    "reference_number": "LOAD123",
    "contact": {
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "15552220123",
      "extension": "123",
      "type": "assigned"
    },
    "type": "owned",
    "stops": [
      {
        "type": "origin",
        "location": {
          "city": "Chicago",
          "state": "IL",
          "zip": "60601",
          "country": "US"
        },
        "stop_timestamp_open": "2024-03-20T14:00:00",
        "stop_timestamp_close": "2024-03-20T16:00:00"
      },
      {
        "type": "destination",
        "location": {
          "city": "New York",
          "state": "NY",
          "zip": "10001",
          "country": "US"
        },
        "stop_timestamp_open": "2024-03-21T14:00:00",
        "stop_timestamp_close": "2024-03-21T16:00:00"
      }
    ],
    "equipment_type": "Dry Van",
    "max_buy": 1500.50,
    "status": "available",
    "is_partial": false,
    "is_hazmat": false,
    "posted_carrier_rate": 1200.00,
    "weight": 40000,
    "number_of_pieces": 100,
    "commodity_type": "Automobile Parts",
    "sale_notes": "This is a test load",
    "dimensions": "53 Feet",
    "branch": "Chicago",
    "miles": 500,
    "bridge": {
      "status": "success",
      "bridge_load_id": "BRK-456789"
    }
    }
  }
}

Retrieve details for a single load by its ID.

Path Parameters

load_id

string

required

The unique identifier of the load

Query Parameters

carrier_id

string

Filter loads available to a specific carrier ID

Response

statusCode

number

HTTP status code

body

object

Response body containing the result

load

object

The load object

Show Load properties

reference_number

string

required

Custom identifier for the load

contact

object

Show Contact properties

name

string

Name of the contact

string

Email address

phone

string

required

Phone number

extension

string

Extension

type

string

Contact type

type

enum

required

Type of load

Show Available values

owned - Load that is already owned
can_get - Load that can be acquired

stops

array

required

List of stops for the load in order of stop sequence

Show Stop properties

type

enum

required

Type of stop

Show Available values

origin - Origin location
destination - Destination location
pick - Pickup location
drop - Drop-off location

location

object

required

Show Location properties

city

string

required

City name

state

string

required

State code

zip

string

required

ZIP/Postal code

country

string

required

Country name

stop_timestamp_open

string

Timestamp for stop window open (format: YYYY-MM-DDTHH:MM:SS without timezone)

stop_timestamp_close

string

Timestamp for stop window close (format: YYYY-MM-DDTHH:MM:SS without timezone)

max_buy

number

required

Maximum buying rate for the load (numeric with up to 2 decimal places)

status

enum

required

Current status of the load

Show Available values

at_pickup - Load is at pickup location
picked_up - Load has been picked up
at_delivery - Load is at delivery location
dispatched - Load has been dispatched
delivered - Load has been delivered
en_route - Load is en route
in_transit - Load is in transit
completed - Load is completed
available - Load is available for booking
covered - Load has been covered
unavailable - Load is unavailable

is_partial

boolean

required

Whether this is a partial load

is_hazmat

boolean

required

Whether this is a hazmat load

posted_carrier_rate

number

required

Rate posted for carriers (numeric with up to 2 decimal places)

sale_notes

string

Additional notes about the sale

branch

string

Branch handling the load

commodity_type

string

required

Type of commodity being transported in a human readable format

weight

number

Weight of the load in pounds (numeric with up to 2 decimal places)

number_of_pieces

integer

Number of pieces in the load

miles

integer

Total miles for the trip

dimensions

string

Dimensions of the load

bridge

object

Integration status information

Show Bridge properties

status

enum

required

Integration processing status

Show Available values

success - Load was successfully processed and integrated
failed - Load processing failed

bridge_load_id

string

The ID assigned to this load in the bridge system (when status is success)

equipment_type

string

required

Equipment type required for the load. Must be one of: Dry Van, Reefer, Flatbed, Step Deck, Box Truck, Power Only

Status Codes

200

number

Successfully retrieved the load

404

number

Load not found with the specified ID

409

number

Multiple loads found with the same ID

500

number

Internal server error.

curl --request GET \
     --url 'https://api.example.com/api/v1/loads/LOAD123' \
     --header 'Authorization: Bearer API_KEY'

{
  "statusCode": 200,
  "body": {
    "load": {
    "reference_number": "LOAD123",
    "contact": {
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "15552220123",
      "extension": "123",
      "type": "assigned"
    },
    "type": "owned",
    "stops": [
      {
        "type": "origin",
        "location": {
          "city": "Chicago",
          "state": "IL",
          "zip": "60601",
          "country": "US"
        },
        "stop_timestamp_open": "2024-03-20T14:00:00",
        "stop_timestamp_close": "2024-03-20T16:00:00"
      },
      {
        "type": "destination",
        "location": {
          "city": "New York",
          "state": "NY",
          "zip": "10001",
          "country": "US"
        },
        "stop_timestamp_open": "2024-03-21T14:00:00",
        "stop_timestamp_close": "2024-03-21T16:00:00"
      }
    ],
    "equipment_type": "Dry Van",
    "max_buy": 1500.50,
    "status": "available",
    "is_partial": false,
    "is_hazmat": false,
    "posted_carrier_rate": 1200.00,
    "weight": 40000,
    "number_of_pieces": 100,
    "commodity_type": "Automobile Parts",
    "sale_notes": "This is a test load",
    "dimensions": "53 Feet",
    "branch": "Chicago",
    "miles": 500,
    "bridge": {
      "status": "success",
      "bridge_load_id": "BRK-456789"
    }
    }
  }
}

Get Loads Get Carrier

Call HappyRobot API

HappyRobot Calls Your API

Path Parameters

Query Parameters

Response

Status Codes

Call HappyRobot API

HappyRobot Calls Your API

​Path Parameters

​Query Parameters

​Response

​Status Codes

Path Parameters

Query Parameters

Response

Status Codes