API documentation | API docs for agents | OpenAPI 3.1

status-update

ark.emit_edi_status_update

Emits a shipment status update for a visible EDI tender linked to a broker load and queues outbound 214 dispatch work.

Availability: Expanded preview
Scopes: edi:write
ARK permissions: canTakeEdiTenderAction
Team visibility: Not entity-scoped
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

statusKeystringrequired

min length: 1; max length: 100

eventAtstring

format: date-time

stopSequenceNumberstring

min length: 1; max length: 50

timeCodestring

min length: 1; max length: 10

appointmentNumberstring

min length: 1; max length: 100

carrierReferenceNumberstring

min length: 1; max length: 100

secondaryCarrierScacstring

min length: 1; max length: 20

proofOfDeliveryNamestring

min length: 1; max length: 200

eventLocationobject

Example request

Shell

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

Success response

EDI status update result

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.tenderIdstringrequired

format: uuid

data.transactionIdstring

format: uuid

data.statusKeystringrequired

data.statusCodestringrequired

data.statusLabelstringrequired

data.duplicateSuppressedbooleanrequired

data.throttledbooleanrequired

data.transportStatusstringrequired

data.dispatchStatusstringrequired

data.mdnStatusstringrequired

data.createdAtstringrequired

format: date-time

data.outboundDispatchQueuedbooleanrequired

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