TradeVowConnectRequest API access
Family F/v1/shipments

Logistics & execution APIs

Connect shipments, transport documents, execution milestones and exceptions to the commercial transaction and its readiness state.

Designed for: Forwarders, carriers, ports, port community systems, customs and inspection providers

MethodEndpoint
POST
/v1/transactions/{transaction_id}/shipments

Create or link a shipment within the transaction.

GET
/v1/shipments/{shipment_id}

Read the permitted shipment projection.

POST
/v1/shipments/{shipment_id}/milestones

Report an observed, estimated or corrected milestone.

POST
/v1/shipments/{shipment_id}/transport-documents

Link transport evidence to a shipment.

POST
/v1/shipments/{shipment_id}/exceptions

Report a delay, mismatch or execution exception.

GET
/v1/transactions/{transaction_id}/execution-status

Read the consolidated, source-aware execution view.

Postman example

Report shipment departure

POST {{base_url}}/v1/shipments/{{shipment_id}}/milestones
X-TradeVow-API-Key: {{api_key}}
Content-Type: application/json
Idempotency-Key: {{$guid}}
X-Correlation-ID: {{$guid}}

Domain rules

  • Provider references are required for deduplication.
  • Observed, estimated and corrected milestones remain distinguishable.
  • Occurrence time is never replaced by ingestion time.
  • Exceptions create traceable actions instead of silently changing status.

Related events

shipment.createdshipment.milestone_reportedshipment.exception_reportedtransport_document.linkedshipment.completed