HappyRobot Calls Your API
Get Load
HappyRobot Calls Your API
Get Load
Get details for a specific load
GET
/
api
/
v1
/
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
The unique identifier of the load
Response
The load object
Custom identifier for the load
Type of load
can-get- Load that can be acquiredowned- Load that is already owned
List of stops for the load in order of stop sequence
Type of stop
Pick- Pickup locationDrop- Drop-off location
ISO 8601 formatted timestamp for stop window open
ISO 8601 formatted timestamp for stop window close
Maximum buying rate for the load
Current status of the load
Available- Load is available for bookingBooked- Load has been bookedIn Transit- Load is currently in transitDelivered- Load has been deliveredCancelled- Load has been cancelled
Whether this is a partial load
Rate posted for carriers
Additional notes about the sale
Branch handling the load
Type of commodity being transported in a human readable format
Weight of the load in pounds
Number of pieces in the load
Total miles for the trip
Dimensions of the load
Equipment type required for the load
Dry Van- Standard enclosed trailerReefer- Refrigerated trailerFlatbed- Open deck trailerStep Deck- Stepped flatbed trailerBox Truck- Box truckPower Only- Tractor only
Status Codes
Successfully retrieved the load
Load not found with the specified ID
Multiple loads found with the same ID
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
}
}
Was this page helpful?
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
}
}