For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDashboard
GuidesAPI Reference
GuidesAPI Reference
  • Endpoints
      • POSTCreate a load
      • POSTBatch create loads
      • GETList loads
      • GETGet a load
      • PATCHUpdate a load
      • GETGet load statistics
LogoLogo
SupportDashboard
EndpointsLoads

Create a load

POST
/loads
POST
/api/v1/loads
$curl -X POST https://tryenvoy.ai/api/v1/loads \
>     -H "Content-Type: application/json" \
>     -d '{
>  "load_number": "string",
>  "equipment_type": "VAN",
>  "stops": [
>    {
>      "location": {
>        "city": "string",
>        "state": "string"
>      }
>    }
>  ]
>}'
1{
2  "success": true,
3  "message": "string",
4  "processed_at": "2024-01-15T09:30:00Z",
5  "load_id": "string"
6}

Create or update a freight load. If a load with the same load_number or tms_load_id exists, it will be updated.

Authentication: API key required.

Was this page helpful?
Previous

Batch create loads

Next
Built with

Request

This endpoint expects an object.
load_numberstringRequired
Unique load reference number
equipment_typeenumRequired
Equipment type used for transport
stopslist of objectsRequired

Ordered list of stops (pickup and dropoff) - minimum 2 required

equipment_type_rawstring or nullOptional

Original equipment-type string from the source TMS (e.g. ‘Van/Reefer 53”, ‘Dry Van 53FT’). Stored verbatim for audit; not used for matching.

tms_load_idstring or nullOptional=18 characters

18-character internal TMS load ID (optional)

tms_statusstring or nullOptional

Status of the load from TMS system (defaults to ‘created’ if not provided)

weightdouble or nullOptional>=0

Weight of the load (must be non-negative)

distancedouble or nullOptional>=0

Number of miles to drive (must be non-negative)

commoditystring or nullOptional
Commodity being hauled
po_numberslist of strings or nullOptional
List of PO or pickup numbers
posted_rateinteger or nullOptional
Posted rate in USD
max_buy_rateinteger or nullOptional
Maximum buy rate in USD
suggested_market_rateinteger or nullOptional
Suggested market rate in USD
length_feetinteger or nullOptional>=0

Length in feet (must be non-negative)

temperature_setting_minimuminteger or nullOptional
Minimum temperature setting in degrees
temperature_setting_maximuminteger or nullOptional
Maximum temperature setting in degrees
temperature_run_typestring or nullOptional

Temperature run type (e.g., continuous, cycle)

last_reported_statestring or nullOptional
Last reported state for tracking
last_reported_citystring or nullOptional
Last reported city for tracking
last_reported_longdouble or nullOptional-180-180

Last reported longitude (-180 to 180, nullable when not moving)

last_reported_latdouble or nullOptional-90-90

Last reported latitude (-90 to 90, nullable when not moving)

tms_carrier_idstring or nullOptional

TMS carrier service ID (e.g., Salesforce CarrierService ID)

carrier_namestring or nullOptional
Name of the carrier
customer_namestring or nullOptional

Name of the customer (shipper)

carrier_repobject or nullOptional
Carrier Sales Representative contact details
driverobject or nullOptional
Driver contact details
special_instructionslist of strings or nullOptional

Special handling instructions provided by the shipper/broker; verbalized to carriers during voice calls

custom_fieldsmap from strings to any or nullOptional

Additional custom fields for source-specific data

Response

Successful Response
successboolean
messagestring
processed_atdatetime
load_idstring or null

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error