API documentation | API docs for agents | OpenAPI 3.1

build-load

ark.build_load_from_spot_quote

Creates a broker load from a visible won spot quote, links the quote to the created load, records the conversion event, and processes queued load-board removals.

Availability: Expanded preview
Scopes: loads:write
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

spotQuoteIdpathstringrequired: format: uuid
Idempotency-Keyheaderstringrequired: Required for external write operations.; min length: 1; max length: 255

Request body

None.

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/spot-quotes/<spotQuoteId>/build-load' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>"

Success response

Created load link result

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.spotQuoteIdstringrequired

format: uuid

data.loadIdstringrequired

format: uuid

data.loadNumberinteger | nullrequired

data.loadBoardRemovalProcessedbooleanrequired

data.sideEffectErrorstring | nullrequired

Errors

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