API documentation | API docs for agents | OpenAPI 3.1

POST /api/v1/spot-quotes

ark.create_spot_quote

Creates a spot quote with pickup, delivery, freight, customer, and team context using the same transactional workflow as the website.

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

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

Request body

customerIdstringrequired

format: uuid

teamIdstring

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

format: uuid

customerEmailstring | null

format: email; max length: 254

currencystring

one of: USD, CAD, MXN

referenceNumberstring | null

max length: 100

loadClassificationstring | null

max length: 100

sylectusLoadTypeinteger | null
vehicleTypestring | null

max length: 100

piecesinteger | null

min: 1

dimensionsLengthnumber | null
dimensionsWidthnumber | null
dimensionsHeightnumber | null
dimensionsUnitstring

one of: inches, feet

weightnumber | null
weightUnitstring

one of: lbs, kg

stackableboolean
hazmatboolean
dockHighboolean
teamDriverRequiredboolean
tsaboolean
notesInternalstring | null

max length: 5000

notesExternalstring | null

max length: 5000

distanceMilesnumber | null

Example request

Shell
curl -X POST 'https://arktms.com/api/v1/spot-quotes' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "customerId": "<customerId>",
  "stops": [
    {
      "sequenceIndex": 0,
      "type": "pickup",
      "city": "<city>",
      "state": "<state>"
    },
    {
      "sequenceIndex": 0,
      "type": "pickup",
      "city": "<city>",
      "state": "<state>"
    }
  ]
}'

Success response

Created spot quote

objectstringrequired
okbooleanrequired
api_versionstringrequired
request_idstringrequired
dataobjectrequired
data.spotQuoteIdstringrequired

format: uuid

data.sideEffectErrorstring | nullrequired

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