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

Update a load

PATCH
/loads/:load_id
PATCH
/api/v1/loads/:load_id
$curl -X PATCH https://tryenvoy.ai/api/v1/loads/load_id \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "id": "load_3f2504e0-4f89-11d3-9a0c-0305e82c3301",
3  "load_number": "LD123456789",
4  "organization_id": "org_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
5  "equipment_type": "VAN",
6  "created_at": "2024-06-15T12:00:00Z",
7  "updated_at": "2024-06-20T15:30:00Z",
8  "tms_load_id": "TMS987654321",
9  "external_id": "EXT123456789",
10  "mode": "FTL",
11  "load_status": "In Transit",
12  "tms_status": "Dispatched",
13  "weight": 45000.5,
14  "distance": 1200.75,
15  "commodity": "Electronics",
16  "po_numbers": [
17    "PO123456789"
18  ],
19  "posted_rate": 1500,
20  "max_buy_rate": 1800,
21  "suggested_market_rate": 1700,
22  "length_feet": 53,
23  "special_instructions": [
24    "Handle with care",
25    "Deliver before noon"
26  ],
27  "is_posted": false,
28  "temperature_setting_minimum": 35,
29  "temperature_setting_maximum": 45,
30  "temperature_run_type": "Refrigerated",
31  "last_reported_state": "CA",
32  "last_reported_city": "Los Angeles",
33  "last_reported_long": -118.2437,
34  "last_reported_lat": 34.0522,
35  "tms_carrier_id": "CARR123456",
36  "carrier_name": "Fast Freight Inc.",
37  "customer_name": "Tech Corp",
38  "carrier_rep": {
39    "type": "CarrierSalesRep",
40    "first_name": "Alice",
41    "last_name": "Johnson",
42    "phone": "+14155552671",
43    "email": "[email protected]"
44  },
45  "driver": {
46    "type": "Driver",
47    "first_name": "Bob",
48    "last_name": "Smith",
49    "phone": "+14155559876",
50    "email": "[email protected]"
51  },
52  "carrier_rep_user_id": "usr_9f8e7d6c-5b4a-3f2e-1d0c-9b8a7f6e5d4c",
53  "stops": [
54    {
55      "location": {
56        "city": "San Jose",
57        "state": "CA",
58        "street": "1234 Tech Park Blvd",
59        "postal_code": "95131",
60        "country": "US",
61        "company_name": "Tech Corp Warehouse",
62        "county": "Santa Clara",
63        "latitude": 37.3382,
64        "longitude": -121.8863
65      },
66      "stop_number": 1,
67      "is_pickup": true,
68      "is_dropoff": false,
69      "expected_date": "2024-07-01T08:00:00Z",
70      "contact": {
71        "type": "Shipper",
72        "first_name": "John",
73        "last_name": "Doe",
74        "phone": "+14155551234",
75        "email": "[email protected]"
76      },
77      "type": "Pickup",
78      "planned": {
79        "start": "2024-07-01T08:00:00Z",
80        "end": "2024-07-01T10:00:00Z"
81      },
82      "pickup_delivery_number": "PU123456",
83      "contacts": [
84        {
85          "type": "Shipper",
86          "first_name": "John",
87          "last_name": "Doe",
88          "phone": "+14155551234",
89          "email": "[email protected]"
90        }
91      ],
92      "actual_stop_times": {
93        "arrival_datetime": "2024-07-01T08:15:00Z",
94        "departure_datetime": "2024-07-01T09:45:00Z"
95      },
96      "carrier_eta": "2024-07-01T08:00:00Z"
97    }
98  ],
99  "context": {},
100  "custom_fields": {},
101  "offer_count": 5,
102  "max_offer_amount": 1750.5
103}

Partial update of a load. Only provided fields will be updated.

Authentication: Supports API key and bearer token authentication.

Was this page helpful?
Previous

Get load statistics

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

load_idstringRequiredformat: "uuid"

Headers

X-Organization-IDstring or nullOptional

Request

This endpoint expects an object.
is_postedboolean or nullOptional

Response

Successful Response
idstringformat: "^load_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
load_numberstring
organization_idstringformat: "^org_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
equipment_typeenum

Canonical equipment types used across loads, carriers, and lane preferences.

Uses StrEnum (not the class X(str, Enum) pattern) so that str(EquipmentType.VAN) and f"{EquipmentType.VAN}" return "VAN" instead of the default Enum.__str__ of "EquipmentType.VAN". Python 3.12 does not collapse __str__/__format__ for (str, Enum) subclasses, which would silently corrupt every f-string and Jinja template that interpolates an equipment type without .value.

created_atdatetime
updated_atdatetime
tms_load_idstring or null
external_idstring or null
modeenum
Allowed values:
load_statusstring or null
tms_statusstring or null
weightdouble or null
distancedouble or null
commoditystring or null
po_numberslist of strings or null
posted_rateinteger or null
max_buy_rateinteger or null
suggested_market_rateinteger or null
length_feetinteger or null
special_instructionslist of strings or null
is_postedbooleanDefaults to false
temperature_setting_minimuminteger or null
temperature_setting_maximuminteger or null
temperature_run_typestring or null
last_reported_statestring or null
last_reported_citystring or null
last_reported_longdouble or null
last_reported_latdouble or null
tms_carrier_idstring or null
carrier_namestring or null
customer_namestring or null
carrier_repobject or null
Contact information for various parties involved in the load
driverobject or null
Contact information for various parties involved in the load
carrier_rep_user_idstringformat: "^usr_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
stopslist of objects
contextmap from strings to any
custom_fieldsmap from strings to any
offer_countintegerDefaults to 0
Number of unique carrier offers received
max_offer_amountdouble or null
Highest offer amount received

Errors

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