Skip to main content

Orderly Intelligence API

The Intelligence API delivers carrier-performance analytics and shipment-level SLA predictions over the shipments you track with Orderly. Submit shipments and tracking events, then read on-time rates, at-risk queues, network hotspots, and per-shipment delivery predictions.

The same predictions power the Intelligence dashboard: a live map, intervention queue, and scorecard you drive from the Orderly portal. If you want to use Intelligence rather than build on it, start with The Intelligence dashboard. Everything below documents the API the dashboard is built on.

How it works​

Send authenticated shipment and tracking data to the Intelligence API, then use the resulting predictions and analytics in your product or in the Orderly dashboard.

Your appBearer token
Authenticated request
Intelligence APIapi.orderlycore.com
Delivery intelligence
Predictions & analyticsAPI and dashboard

Base URLs​

EnvironmentBase URL
Productionhttps://api.orderlycore.com
Previewhttps://api-staging.orderlycore.com

All endpoints live under the /v1 prefix, for example GET /v1/overview.

Response shape​

Every response uses a single envelope, so a client can rely on one shape:

{
  "ok": true,
  "data": { },
  "meta": { "requestId": "…", "version": "0.1.0" }
}

Errors return ok: false with a stable code and message:

{
  "ok": false,
  "error": { "code": "org_required", "message": "X-Organization-Id header is required." },
  "meta": { "requestId": "…", "version": "0.1.0" }
}

Every response carries an X-Request-Id header for correlation.

Next steps​