API documentation | API docs for agents | OpenAPI 3.1
POST /api/v1/loads/bulk
ark.bulk_create_loads
Creates 1-25 available loads from one load template plus row-level customer reference, BOL, PO, and stop appointment overrides.
- Availability
- Expanded preview
- Scopes
loads:dispatch- ARK permissions
canCreateLoad- Team visibility
- Required and enforced
- Idempotency-Key
- Required for this write
- Approval
- No MCP approval on REST API-token calls
- Rate limit
- API credential and organization budgets
Parameters
Idempotency-Keyheaderstringrequired- Required for external write operations. Reuse the same key only for exact retries of the same request body.
- min length: 1; max length: 200
Request body
templateobjectrequiredrowsarray<object>requiredmin items: 1; max items: 25
Example request
Shell
curl -X POST 'https://arktms.com/api/v1/loads/bulk' \
-H "Authorization: Bearer $ARK_API_TOKEN" \
-H "Idempotency-Key: <unique-key>" \
-H "Content-Type: application/json" \
-d '{
"template": {
"customerId": "<customerId>",
"teamId": "<teamId>",
"trailer": "<trailer>",
"stops": [
{
"locationId": "<locationId>",
"index": 0,
"type": "<type>"
},
{
"locationId": "<locationId>",
"index": 0,
"type": "<type>"
}
]
},
"rows": [
{
"customerRef": "<customerRef>"
}
]
}'Success response
Created loads
objectstringrequiredokbooleanrequiredapi_versionstringrequiredrequest_idstringrequireddataobjectrequireddata.createdCountintegerrequiredmin: 0
data.itemsarray<object>requireddata.messagestringrequiredErrors
HTTP 400- Invalid request
HTTP 401- Authentication required
HTTP 403- Permission, scope, team, or entitlement denied
HTTP 404- Resource not found
HTTP 409- Idempotency conflict or in-progress retry