API documentation | API docs for agents | OpenAPI 3.1

build-load

ark.build_load_from_edi_tender

Creates a broker load from an accepted visible EDI tender. Returns structured review-plan details in error.details.plan when customer, team, customer pay, or location resolution needs operator input.

Availability: Expanded preview
Scopes: edi:readloads:write
ARK permissions: canViewEdicanCreateLoad
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

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

Request body

customerIdstring

Customer ID to use when the EDI shipper mapping is missing or ambiguous.

format: uuid

teamIdstring

Visible team ID for the created load. Omit only when the connection has one visible team.

format: uuid

manualCustomerRatenumber | string | null

Customer rate to use when the EDI tender does not include a trusted customer-pay value.

manualCustomerRateExplicitZeroboolean

Set true only when a zero manual customer rate is intentional.

reviewedLoadCreateArgsobject

Reviewed load-create argument overrides from the load-review flow. Use only after a review plan is returned.

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/edi/tenders/<tenderId>/build-load' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{}'

Success response

EDI tender load build result

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.tenderIdstringrequired

format: uuid

data.loadIdstringrequired

format: uuid

data.loadNumberinteger | nullrequired

data.statusstringrequired

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 409: Idempotency conflict or in-progress retry
HTTP 422: Tender needs review before a load can be created. The response error details include a load-build plan.