Load Event

{
  "event_type": "load_upsert",
  "org_id": "01111111-11aa-11aa-1111-a11111111111",
  "custom_load_id": "123455555555",
  "equipment_type_name": "Dry Van",
  "status": "available",
  "posted_carrier_rate": 1500.00,
  "max_buy": 1200.00,
  "type": "owned",
  "is_partial": false,
  "weight": 25000,
  "number_of_pieces": 10,
  "miles": 750,
  "commodity_type": "General Merchandise",
  "pickup_date_open": "2023-06-15T08:00:00",
  "pickup_date_close": "2023-06-15T12:00:00",
  "delivery_date_open": "2023-06-16T09:00:00",
  "delivery_date_close": "2023-06-16T13:00:00",
  "contacts": [
    {
      "name": "John Smith",
      "email": "john@example.com",
      "phone": "5551234567",
      "type": "assigned",
      "extension": "123"
    }
  ],
  "origin": {
    "city": "Chicago",
    "state": "IL",
    "zip": "60601",
    "country": "US",
    "address": "123 Main St"
  },
  "destination": {
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "country": "US",
    "address": "456 Park Ave"
  },
  "stops": [
    {
      "type": "origin",
      "location": {
        "city": "Chicago",
        "state": "IL",
        "zip": "60601",
        "country": "US",
        "address": "123 Main St"
      },
      "stop_timestamp_open": "2023-06-15T08:00:00",
      "stop_timestamp_close": "2023-06-15T12:00:00",
      "stop_order": 1,
      "notes": "Pickup at loading dock"
    },
    {
      "type": "pick",
      "location": {
        "city": "Cleveland",
        "state": "OH",
        "zip": "44113",
        "country": "US"
      },
      "stop_timestamp_open": "2023-06-16T09:00:00",
      "stop_timestamp_close": "2023-06-16T13:00:00",
      "stop_order": 2
    },
    {
      "type": "destination",
      "location": {
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "country": "US",
        "address": "456 Park Ave"
      },
      "stop_timestamp_open": "2023-06-17T10:00:00",
      "stop_timestamp_close": "2023-06-17T14:00:00",
      "stop_order": 3,
      "notes": "Call 30 minutes before arrival"
    }
  ],
  "min_temp": 32,
  "max_temp": 38,
  "is_temp_metric": false,
  "cargo_value": 50000,
  "is_hazmat": false,
  "is_team_required": false
}

{
  "id": "01111111-11aa-11aa-1111-a11111111111",
  "created_at": "2024-03-19T08:00:00Z",
  "status": "available",
  "custom_load_id": "LOAD123"
}

POST

api

loads

{
  "event_type": "load_upsert",
  "org_id": "01111111-11aa-11aa-1111-a11111111111",
  "custom_load_id": "123455555555",
  "equipment_type_name": "Dry Van",
  "status": "available",
  "posted_carrier_rate": 1500.00,
  "max_buy": 1200.00,
  "type": "owned",
  "is_partial": false,
  "weight": 25000,
  "number_of_pieces": 10,
  "miles": 750,
  "commodity_type": "General Merchandise",
  "pickup_date_open": "2023-06-15T08:00:00",
  "pickup_date_close": "2023-06-15T12:00:00",
  "delivery_date_open": "2023-06-16T09:00:00",
  "delivery_date_close": "2023-06-16T13:00:00",
  "contacts": [
    {
      "name": "John Smith",
      "email": "john@example.com",
      "phone": "5551234567",
      "type": "assigned",
      "extension": "123"
    }
  ],
  "origin": {
    "city": "Chicago",
    "state": "IL",
    "zip": "60601",
    "country": "US",
    "address": "123 Main St"
  },
  "destination": {
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "country": "US",
    "address": "456 Park Ave"
  },
  "stops": [
    {
      "type": "origin",
      "location": {
        "city": "Chicago",
        "state": "IL",
        "zip": "60601",
        "country": "US",
        "address": "123 Main St"
      },
      "stop_timestamp_open": "2023-06-15T08:00:00",
      "stop_timestamp_close": "2023-06-15T12:00:00",
      "stop_order": 1,
      "notes": "Pickup at loading dock"
    },
    {
      "type": "pick",
      "location": {
        "city": "Cleveland",
        "state": "OH",
        "zip": "44113",
        "country": "US"
      },
      "stop_timestamp_open": "2023-06-16T09:00:00",
      "stop_timestamp_close": "2023-06-16T13:00:00",
      "stop_order": 2
    },
    {
      "type": "destination",
      "location": {
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "country": "US",
        "address": "456 Park Ave"
      },
      "stop_timestamp_open": "2023-06-17T10:00:00",
      "stop_timestamp_close": "2023-06-17T14:00:00",
      "stop_order": 3,
      "notes": "Call 30 minutes before arrival"
    }
  ],
  "min_temp": 32,
  "max_temp": 38,
  "is_temp_metric": false,
  "cargo_value": 50000,
  "is_hazmat": false,
  "is_team_required": false
}

{
  "id": "01111111-11aa-11aa-1111-a11111111111",
  "created_at": "2024-03-19T08:00:00Z",
  "status": "available",
  "custom_load_id": "LOAD123"
}

Create a new load with all associated details including pickup/delivery information, equipment requirements, and pricing. This can only be used if you coordinate with us, we will need to give you an API key and the endpoint to use.

Authentication

This endpoint requires an API key in the X-API-Key header:

X-API-Key: <your_api_key>

Body

event_type

string

required

Type of event. Must be ‘load_upsert’.

org_id

string

Your organization’s unique identifier

custom_load_id

string

required

Custom identifier for the load (This is the load number you use in your TMS)

equipment_type_name

string

Name of the required equipment type

status

enum

required

Load status. Must be one of: - at_pickup - picked_up - at_delivery - dispatched - delivered - en_route - in_transit - completed - available - covered - unavailable

posted_carrier_rate

number

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

type

enum

default:"owned"

Type of load. Must be one of: - owned - can_get

is_partial

boolean

default:"false"

Whether this is a partial load

contacts

array

List of contacts for this load

Show Contact properties

name

string

required

Name of the contact

string

required

Email address

phone

string

required

Phone number (digits only)

type

enum

required

Contact type. Must be one of: - assigned - transfer

extension

string

Phone extension

origin

object

Origin location

Show Location properties

city

string

required

City name

state

string

required

State code

zip

string

required

ZIP/Postal code

country

string

default:"US"

Country code

address

string

Street address

destination

object

Destination location

Show Location properties

city

string

required

City name

state

string

required

State code

zip

string

required

ZIP/Postal code

country

string

default:"US"

Country code

address

string

Street address

stops

array

List of stops for this load. NOTE: You have to pass in the origin and destination

Show Stop properties

type

enum

required

Type of stop. Must be one of: - origin - destination - pick - drop

location

object

required

Show Location properties

city

string

required

City name

state

string

required

State code

zip

string

required

ZIP/Postal code

country

string

default:"US"

Country code

address

string

Street address

loading_type

string

Type of loading required

notes

string

Additional notes for this stop

stop_timestamp_open

string

required

Timestamp for when the stop window opens (format: YYYY-MM-DDTHH:MM:SS without timezone). We will not do any timezone conversions.

stop_timestamp_close

string

required

Timestamp for when the stop window closes (format: YYYY-MM-DDTHH:MM:SS without timezone). We will not do any timezone conversions.

stop_order

integer

required

Order of this stop in the sequence

max_buy

number

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

sale_notes

string

Additional notes about the sale

branch

string

Branch handling the load

commodity_type

string

Type of commodity being transported

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

pickup_date_open

string

Timestamp for pickup window open (format: YYYY-MM-DDTHH:MM:SS without timezone). We will not do any timezone conversions.

pickup_date_close

string

Timestamp for pickup window close (format: YYYY-MM-DDTHH:MM:SS without timezone). We will not do any timezone conversions.

delivery_date_open

string

Timestamp for delivery window open (format: YYYY-MM-DDTHH:MM:SS without timezone). We will not do any timezone conversions.

delivery_date_close

string

Timestamp for delivery window close (format: YYYY-MM-DDTHH:MM:SS without timezone). We will not do any timezone conversions.

temp_configuration

string

Temperature configuration requirements

min_temp

number

Minimum temperature requirement (numeric with up to 2 decimal places)

max_temp

number

Maximum temperature requirement (numeric with up to 2 decimal places)

is_temp_metric

boolean

Whether temperature is in metric units

pickup_number

string

Pickup reference number

bol_number

string

Bill of Lading number

trailer_number

string

Trailer number

truck_number

string

Truck number

cargo_value

number

Value of the cargo (numeric with up to 2 decimal places)

is_hazmat

boolean

Whether the load contains hazardous materials

po_number

string

Purchase order number

is_team_required

boolean

Whether a team driver is required

un_number

string

UN number for hazardous materials

package_group

string

Package group for hazardous materials

hazmat_class

string

Hazmat class

is_hazardous

boolean

Whether the load is hazardous

Response

string

The UUID of the created load

created_at

string

ISO 8601 formatted creation timestamp

{
  "event_type": "load_upsert",
  "org_id": "01111111-11aa-11aa-1111-a11111111111",
  "custom_load_id": "123455555555",
  "equipment_type_name": "Dry Van",
  "status": "available",
  "posted_carrier_rate": 1500.00,
  "max_buy": 1200.00,
  "type": "owned",
  "is_partial": false,
  "weight": 25000,
  "number_of_pieces": 10,
  "miles": 750,
  "commodity_type": "General Merchandise",
  "pickup_date_open": "2023-06-15T08:00:00",
  "pickup_date_close": "2023-06-15T12:00:00",
  "delivery_date_open": "2023-06-16T09:00:00",
  "delivery_date_close": "2023-06-16T13:00:00",
  "contacts": [
    {
      "name": "John Smith",
      "email": "john@example.com",
      "phone": "5551234567",
      "type": "assigned",
      "extension": "123"
    }
  ],
  "origin": {
    "city": "Chicago",
    "state": "IL",
    "zip": "60601",
    "country": "US",
    "address": "123 Main St"
  },
  "destination": {
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "country": "US",
    "address": "456 Park Ave"
  },
  "stops": [
    {
      "type": "origin",
      "location": {
        "city": "Chicago",
        "state": "IL",
        "zip": "60601",
        "country": "US",
        "address": "123 Main St"
      },
      "stop_timestamp_open": "2023-06-15T08:00:00",
      "stop_timestamp_close": "2023-06-15T12:00:00",
      "stop_order": 1,
      "notes": "Pickup at loading dock"
    },
    {
      "type": "pick",
      "location": {
        "city": "Cleveland",
        "state": "OH",
        "zip": "44113",
        "country": "US"
      },
      "stop_timestamp_open": "2023-06-16T09:00:00",
      "stop_timestamp_close": "2023-06-16T13:00:00",
      "stop_order": 2
    },
    {
      "type": "destination",
      "location": {
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "country": "US",
        "address": "456 Park Ave"
      },
      "stop_timestamp_open": "2023-06-17T10:00:00",
      "stop_timestamp_close": "2023-06-17T14:00:00",
      "stop_order": 3,
      "notes": "Call 30 minutes before arrival"
    }
  ],
  "min_temp": 32,
  "max_temp": 38,
  "is_temp_metric": false,
  "cargo_value": 50000,
  "is_hazmat": false,
  "is_team_required": false
}

{
  "id": "01111111-11aa-11aa-1111-a11111111111",
  "created_at": "2024-03-19T08:00:00Z",
  "status": "available",
  "custom_load_id": "LOAD123"
}

Carrier Event

Call HappyRobot API

HappyRobot Calls Your API

Authentication

Body

Response

Call HappyRobot API

HappyRobot Calls Your API

​Authentication

​Body

​Response

Authentication

Body

Response