POST
/
api
/
v1
/
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": "2023-06-15T08:00:00Z",
  "delivery_date": "2023-06-17T14:00:00Z",
  "origin": {
    "city": "Chicago",
    "state": "IL",
    "zip_code": "60601",
    "country": "USA"
  },
  "destination": {
    "city": "New York",
    "state": "NY",
    "zip_code": "10001",
    "country": "USA"
  },
  "stops": [
    {
      "type": "Pick",
      "location": {
        "city": "Chicago",
        "state": "IL",
        "zip_code": "60601"
      },
      "stop_timestamp_open": "2023-06-15T08:00:00Z",
      "stop_timestamp_close": "2023-06-15T12:00:00Z",
      "stop_order": 1
    },
    {
      "type": "Pick",
      "location": {
        "city": "Cleveland",
        "state": "OH",
        "zip_code": "44113"
      },
      "stop_timestamp_open": "2023-06-16T09:00:00Z",
      "stop_timestamp_close": "2023-06-16T13:00:00Z",
      "stop_order": 2
    },
    {
      "type": "Delivery",
      "location": {
        "city": "New York",
        "state": "NY",
        "zip_code": "10001"
      },
      "stop_timestamp_open": "2023-06-17T10:00:00Z",
      "stop_timestamp_close": "2023-06-17T14:00:00Z",
      "stop_order": 3
    }
  ]
}

{
  "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. For now, only ‘load_upsert’ is supported.

​
contact
object

Contact information for this load

​
type
enum
default:"owned"

Type of load. Must be one of: - can-get - owned

​
custom_load_id
string
required

Custom identifier for the load

​
stops
array

List of stops for this load

​
max_buy
number

Maximum buying rate for the load

​
status
enum
required

Load status. Must be one of: - Available - Covered - Eload - ThirdShift - Hold - EloadFortus - AcceptingOffers - Unavailable

​
is_partial
boolean
default:"false"

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

Type of commodity being transported

​
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_name
string
required

Name of the required equipment type

​
Response

​
id
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": "2023-06-15T08:00:00Z",
  "delivery_date": "2023-06-17T14:00:00Z",
  "origin": {
    "city": "Chicago",
    "state": "IL",
    "zip_code": "60601",
    "country": "USA"
  },
  "destination": {
    "city": "New York",
    "state": "NY",
    "zip_code": "10001",
    "country": "USA"
  },
  "stops": [
    {
      "type": "Pick",
      "location": {
        "city": "Chicago",
        "state": "IL",
        "zip_code": "60601"
      },
      "stop_timestamp_open": "2023-06-15T08:00:00Z",
      "stop_timestamp_close": "2023-06-15T12:00:00Z",
      "stop_order": 1
    },
    {
      "type": "Pick",
      "location": {
        "city": "Cleveland",
        "state": "OH",
        "zip_code": "44113"
      },
      "stop_timestamp_open": "2023-06-16T09:00:00Z",
      "stop_timestamp_close": "2023-06-16T13:00:00Z",
      "stop_order": 2
    },
    {
      "type": "Delivery",
      "location": {
        "city": "New York",
        "state": "NY",
        "zip_code": "10001"
      },
      "stop_timestamp_open": "2023-06-17T10:00:00Z",
      "stop_timestamp_close": "2023-06-17T14:00:00Z",
      "stop_order": 3
    }
  ]
}

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

Was this page helpful?