Skip to main content

Quickstart

Make your first authenticated call to the Intelligence API in a few minutes.

1. Get a token​

You need a bearer token, either a user session token or a provisioned API key. See Authentication.

Export it, plus your organization id:

export ORDERLY_INTEL_KEY="your-token"
export ORG_ID="your-organization-uuid"

2. Read your network overview​

curl https://api.orderlycore.com/v1/overview \
  -H "Authorization: Bearer $ORDERLY_INTEL_KEY" \
  -H "X-Organization-Id: $ORG_ID"
{
  "ok": true,
  "data": {
    "on_time_pct": 94.2,
    "in_transit": 812,
    "delivered": 15340,
    "avg_transit_days": 2.7,
    "at_risk": 37
  },
  "meta": { "requestId": "…", "version": "0.1.0" }
}

3. Predict one shipment​

curl "https://api.orderlycore.com/v1/shipment-predict?tracking=1Z999AA10123456784" \
  -H "Authorization: Bearer $ORDERLY_INTEL_KEY"

4. Discover the surface​

GET /v1/capabilities returns route availability so an integration can feature-detect without guessing:

curl https://api.orderlycore.com/v1/capabilities \
  -H "Authorization: Bearer $ORDERLY_INTEL_KEY"

Next​