Get Load

GET

api

loads

{load_id}

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

{
  "status": 200,
  "load": {
    "reference_number": "LOAD123",
    "contact": {
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "15552220123",
      "extension": "123",
      "type": "Sales Rep"
    },
    "type": "owned",
    "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",
    "dimensions": "53 Feet",
    "branch": "Chicago",
    "miles": 500
  }
}

Retrieve details for a single load by its ID.

Path Parameters

load_id

string

required

The unique identifier of the load

Response

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

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

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

Pick - Pickup location
Drop - Drop-off location

location

object

required

Show Location properties

city

string

required

City name

state

string

required

State code

zip_code

string

required

ZIP/Postal code

country

string

required

Country name

stop_timestamp_open

string

ISO 8601 formatted timestamp for stop window open

stop_timestamp_close

string

ISO 8601 formatted timestamp for stop window close

max_buy

number

required

Maximum buying rate for the load

status

enum

required

Current status of the load

Show Available values

Available - Load is available for booking
Booked - Load has been booked
In Transit - Load is currently in transit
Delivered - Load has been delivered
Cancelled - Load has been cancelled

is_partial

boolean

required

Whether this is a partial load

posted_carrier_rate

number

required

Rate posted for carriers

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

number_of_pieces

integer

Number of pieces in the load

miles

integer

Total miles for the trip

dimensions

string

Dimensions of the load

equipment_type

object

required

Show Equipment type properties

name

enum

required

Equipment type required for the load

Show Available values

Dry Van - Standard enclosed trailer
Reefer - Refrigerated trailer
Flatbed - Open deck trailer
Step Deck - Stepped flatbed trailer
Box Truck - Box truck
Power Only - Tractor only

details

object

Show Equipment-specific details

max_temp

number

Maximum allowed temperature (only applicable for Reefer) in degrees Fahrenheit

min_temp

number

Minimum allowed temperature (only applicable for Reefer) in degrees Fahrenheit

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'

{
  "status": 200,
  "load": {
    "reference_number": "LOAD123",
    "contact": {
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "15552220123",
      "extension": "123",
      "type": "Sales Rep"
    },
    "type": "owned",
    "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",
    "dimensions": "53 Feet",
    "branch": "Chicago",
    "miles": 500
  }
}

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

{
  "status": 200,
  "load": {
    "reference_number": "LOAD123",
    "contact": {
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "15552220123",
      "extension": "123",
      "type": "Sales Rep"
    },
    "type": "owned",
    "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",
    "dimensions": "53 Feet",
    "branch": "Chicago",
    "miles": 500
  }
}

GET

api

loads

{load_id}

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

{
  "status": 200,
  "load": {
    "reference_number": "LOAD123",
    "contact": {
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "15552220123",
      "extension": "123",
      "type": "Sales Rep"
    },
    "type": "owned",
    "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",
    "dimensions": "53 Feet",
    "branch": "Chicago",
    "miles": 500
  }
}

Retrieve details for a single load by its ID.

Path Parameters

load_id

string

required

The unique identifier of the load

Response

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

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

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

Pick - Pickup location
Drop - Drop-off location

location

object

required

Show Location properties

city

string

required

City name

state

string

required

State code

zip_code

string

required

ZIP/Postal code

country

string

required

Country name

stop_timestamp_open

string

ISO 8601 formatted timestamp for stop window open

stop_timestamp_close

string

ISO 8601 formatted timestamp for stop window close

max_buy

number

required

Maximum buying rate for the load

status

enum

required

Current status of the load

Show Available values

Available - Load is available for booking
Booked - Load has been booked
In Transit - Load is currently in transit
Delivered - Load has been delivered
Cancelled - Load has been cancelled

is_partial

boolean

required

Whether this is a partial load

posted_carrier_rate

number

required

Rate posted for carriers

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

number_of_pieces

integer

Number of pieces in the load

miles

integer

Total miles for the trip

dimensions

string

Dimensions of the load

equipment_type

object

required

Show Equipment type properties

name

enum

required

Equipment type required for the load

Show Available values

Dry Van - Standard enclosed trailer
Reefer - Refrigerated trailer
Flatbed - Open deck trailer
Step Deck - Stepped flatbed trailer
Box Truck - Box truck
Power Only - Tractor only

details

object

Show Equipment-specific details

max_temp

number

Maximum allowed temperature (only applicable for Reefer) in degrees Fahrenheit

min_temp

number

Minimum allowed temperature (only applicable for Reefer) in degrees Fahrenheit

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'

{
  "status": 200,
  "load": {
    "reference_number": "LOAD123",
    "contact": {
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "15552220123",
      "extension": "123",
      "type": "Sales Rep"
    },
    "type": "owned",
    "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",
    "dimensions": "53 Feet",
    "branch": "Chicago",
    "miles": 500
  }
}

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

{
  "status": 200,
  "load": {
    "reference_number": "LOAD123",
    "contact": {
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "15552220123",
      "extension": "123",
      "type": "Sales Rep"
    },
    "type": "owned",
    "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",
    "dimensions": "53 Feet",
    "branch": "Chicago",
    "miles": 500
  }
}

Path Parameters

Response

Status Codes

Call HappyRobot API

HappyRobot Calls Your API

Get Load

Path Parameters

Response

Status Codes

​Path Parameters

​Response

​Status Codes

Call HappyRobot API

HappyRobot Calls Your API

​Path Parameters

​Response

​Status Codes

Path Parameters

Response

Status Codes

Path Parameters

Response

Status Codes