API & integrations
PlannedAPI and integrations.
Your systems should not have to ask where a shipment is. The API is planned, not open: this page shows its design so you can tell us what you need from it.
Resource model
Five resources, one record.
The API exposes the same record the portal shows. The fields below are a draft.
| Resource | What it represents | Key fields |
|---|---|---|
| Shipments | One record per shipment: its route, its freight, its status and who holds it. | id, mode, service, origin, destination, status, eta, custody |
| Tracking events | The milestones of a shipment, in order, each with its five facts. | code, state, at, place, party, status, documents |
| Quotes | A request for a price and the written answer to it. | id, lane, freight, valid_until, total, includes |
| Documents | The files attached to a shipment, with who issued each. | id, name, state, issued_by, available |
| Webhooks | A message to your system when a milestone is reached or an exception is reported. | event, shipment_id, occurred_at, data |
A draft example
One request, one event.
Built from the sample shipment. The host is a placeholder: no production address exists yet.
GET https://api.example.invalid/v1/shipments/EW-US-102845
{
"id": "EW-US-102845",
"mode": "air",
"service": "Air freight, door to door",
"origin": "Austin, TX",
"destination": "Dubai, UAE",
"status": "in_transit",
"eta": "2026-10-15T09:00:00.000Z",
"custody": {
"party": "Ground handler",
"place": "Houston, TX",
"since": "2026-10-11T19:48:00.000Z"
}
}POST https://your-system.example/webhooks/erisworlds
{
"event": "shipment.milestone.reached",
"shipment_id": "EW-US-102845",
"occurred_at": "2026-10-11T19:48:00.000Z",
"data": {
"code": "origin_hub",
"state": "current",
"place": "Houston, TX",
"party": "Ground handler",
"status": "Cargo screened and accepted for carriage. Booked on the next departure to Dubai."
}
}Integrations
What we plan to connect.
None of these is built. Tell us which one you need; it decides the order.
E-commerce platforms
PlannedOrders in, tracking numbers back, without retyping.ERP and TMS
PlannedShipments created from your orders, and status written back to them.EDI 204 and 990
PlannedThe load tender to a carrier, and the carrier's response accepting or declining it.EDI 214 and 210
PlannedThe carrier's shipment status message, and the freight invoice.
Design principles
Four rules the API is designed to.
Stable identifiers
A shipment keeps its number for life. Nothing you store will need to be remapped.
Idempotent writes
Sending the same request twice creates one shipment, not two.
Events first
Your system is told when something happens. It does not have to keep asking.
Least-privilege keys
A key does one job: read tracking, or create shipments, not both unless you say so.
Early access
Tell us what you would build.
The systems you run and the events you need shape the first version.
Not a developer?
The customer portal shows the same record on a screen.