API V3 – Post a Load Announcement

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

For TMS integrators, this endpoint is most useful when the broker creates a new load tender in your software. Our Load Announcements tool is the perfect complement to your own digital carrier matching system and helps to insure that our mutual customer gets the fastest and most effective coverage on every load.

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 tender is created.

Notes on this endpoint:

  1. Requires secret key. This endpoint must be called from the server side to avoid compromising your secret API key. Please 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
email
string
Email address of the VETCarriers user who is making the API call
phone
string
Contact phone of the VETCarriers agent, or specific broker agent, who is posting the load
load_number
string
Our API will accept the load numbers that are generated by your TMS or integrated app. The only requirement is that it is passed in string format.
type
string
One of:


equipment
string
One or more of the following values, separated by commas:















Example:

origin_zip
string
The origin zip code. For US zip codes, only 5-digit format is accepted (omit the plus-4). For Canadian zip codes, only the first three characters are accepted.
destination_zip
string
The origin zip code. For US zip codes, only 5-digit format is accepted (omit the plus-4). For Canadian zip codes, only the first three characters are accepted.
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
delivery_date_earliest
string
The earliest available delivery date, in YYYY-MM-DD format
delivery_date_latest
string
The latest available delivery date, in YYYY-MM-DD format
shipper_loading
string
One of:




The shipper's loading policy: either appt for appointment-only or fcfs for first-come, first-serve.
receiver_unloading
string
One of:




The receiver's unloading policy: either appt for appointment-only or fcfs for first-come, first-serve.

Optional parameters

Name
Type
Value(s)
phone_ext
string
Phone extension of the VETCarriers agent, or specific broker agent, who is posting the load
shipper_24hours
string
One of:




Specify whether or not the shipper is open 24 hours.
receiver_24hours
string
One of:




Specify whether or not the receiver is open 24 hours.
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
notified_carriers
array
[]
An array of up to 200 objects, each with the following fields:

{
string
string
string
string
string
string
}

Of note, the reason field refers to the reason why the carrier was selected to be notified about the load.
response
object
{}
An object with the following fields:

{
string
integer
integer
}

Example response

{
    "notified_carriers": [
        {
            "business_name": "AWESOME CARRIER INC",
            "dot_num": "9876543",
            "docket_num": "987654",
            "phone": "5558675310",
            "email": "dispatch@awesomecarrier.com",
            "reason": "Previously covered this lane."
        },
        {
            "business_name": "ALSO AWESOME CARRIER LLC",
            "dot_num": "8765432",
            "docket_num": "876543",
            "phone": "5558675311",
            "email": "dispatch@alsoawesomecarrier.com",
            "reason": "Lists this exact lane in lane preferences."
        }

        # This array will contain up to 200 objects like the above.

    ],
    "response": {
        "date_time": "2022-11-28 19:18:24 UTC",
        "timestamp": 1669663104,
        "status": 200
    }
}