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

Batch create loads

POST
/loads/batch
POST
/api/v1/loads/batch
$curl -X POST https://tryenvoy.ai/api/v1/loads/batch \
> -H "Content-Type: application/json" \
> -d '{
> "loads": [
> {
> "load_number": "string",
> "equipment_type": "VAN",
> "stops": [
> {
> "location": {
> "city": "string",
> "state": "string"
> }
> }
> ]
> }
> ]
>}'
1{
2 "success": true,
3 "total_loads": 1,
4 "successful": 1,
5 "failed": 1,
6 "created": 1,
7 "updated": 1,
8 "results": [
9 {
10 "load_identifier": "string",
11 "success": true,
12 "load_id": "string",
13 "operation": "string",
14 "error": "string"
15 }
16 ],
17 "processed_at": "2024-01-15T09:30:00Z"
18}

Create multiple freight loads in a single request. Each load is processed independently.

Authentication: API key required.

Was this page helpful?
Previous

List loads

Next
Built with

Request

This endpoint expects an object.
loadslist of objectsRequired

List of TMS loads to ingest (max 1000 per batch)

Response

Successful Response
successboolean
True if at least one load was processed successfully
total_loadsinteger
Total number of loads in the batch
successfulinteger
Number of loads processed successfully
failedinteger
Number of loads that failed to process
createdinteger
Number of new loads created
updatedinteger
Number of existing loads updated
resultslist of objects
Detailed results for each load
processed_atdatetime
Timestamp when batch was processed

Errors

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