Skip to main content

Post a load announcement

The /v2/load/announcements/post endpoint lets you post a load announcement to your BrokerCarrier account and send email notifications to the relevant carrier dispatchers.

For TMS integrators, call this endpoint when your user creates a new load in your software. Our API will accept any load number format, so there is no need to create a second identifier other than the load number that your software already generates when the load is created.

This endpoint must be called from the server side to avoid compromising your secret API key. Do not use your secret key in client-side JavaScript.

HTTP request

Method
URL
POST

Required parameters

Name
Type
Value(s)
pk
string
Your public API key
sk
string
Your secret API key
load_number
string
The unique load ID number. Our API will accept the load numbers that are generated by your TMS.
type
string
One of:


equipment
string
One of:










origin_zip
string
The origin zip code. For US zip codes, only 5-digit format is accepted. Omit the plus-4.
destination_zip
string
The destination zip code. For US zip codes, only 5-digit format is accepted. Omit the plus-4.
distance
string
The road distance of the lane in miles, e.g. 532.6. String may only contain numbers and a period. Only numbers are required.

For example, 1150 and 1150.0 are acceptable, while 1,150.0 is not.
pickup_date_earliest
string
The earliest available pickup date, in YYYY-MM-DD format
pickup_date_latest
string
The latest available pickup date, in YYYY-MM-DD format. This can be the same date as pickup_date_earliest.

Optional parameters

Name
Type
Value(s)
delivery_date
string
The delivery date, in YYYY-MM-DD format
rate
string
The rate expressed as a number with two decimal places, e.g. 1250.00. String may only contain numbers and a period. Only numbers are required.

For example, 1250 and 1250.00 are acceptable, while 1,250.00 is not.
weight
string
The weight expressed in pounds, e.g. 43480.0. String may only contain numbers and a period. Only numbers are required.

For example, 43480 and 43480.0 are acceptable, while 43,480.0 is not.
length
string
The length expressed in feet, e.g. 36.0. String may only contain numbers and a period. Only numbers are required.

For example, 36 and 36.0 are both acceptable.
width
string
The width expressed in feet, e.g. 12.0. String may only contain numbers and a period. Only numbers are required.

For example, 12 and 12.0 are both acceptable.
services
string
One or more of the following values, separated by commas:











Example:

commodity
string
The commodity being hauled. Spaces and punctuation are allowed.

Examples:


notes
string
Further info about the load. Spaces and punctuation are allowed.

Example:


Return values

This endpoint returns an object with the following keys and values.

Key
Type
Value
load_number
string
The load number, as formatted in the API call
notified_emails
array
[]
The list of dispatcher emails that were notified about this load. Up to 500 items.

Example response

{
    "load_number": "147000152-136",
    "notified_emails": [
        "dispatch@acmetrucking.com",
        "dispatch@fictionalfreightllc.com"
    ],
    "status": 200
}