Analytics

Network-level performance reads over your tracked shipments.

Served by the gateway at https://api.orderlycore.com under /v1, bearer-authenticated. Use the Try it consoles against the Preview server.

Network KPIs

GET/v1/overview

On-time rate, in-transit and delivered counts, average transit days, and the at-risk count. Falls back to a global view when no organization is supplied. Org-scoped when X-Organization-Id is supplied. Live.

Responses

200 Success. Payload wrapped in the standard envelope:

{
  "ok": true,
  "data": {
    "on_time_pct": 94.2,
    "in_transit": 812,
    "delivered": 15340,
    "avg_transit_days": 2.7,
    "at_risk": 37
  },
  "meta": {
    "requestId": "\u2026",
    "version": "0.1.0"
  }
}

401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/overview

Network KPIs

API key (Bearer token)

X-Organization-Id *

https://api-staging.orderlycore.com/v1/overview

On-time by carrier

GET/v1/carriers

On-time percentage and volume per carrier, ranked by volume (carriers with a meaningful sample only). Org-scoped when X-Organization-Id is supplied. Live.

Responses

200 Success. Payload wrapped in the standard envelope:

{
  "ok": true,
  "data": {
    "carriers": [
      {
        "carrier": "UPS",
        "on_time_pct": 95.1,
        "volume": 8240
      },
      {
        "carrier": "FEDEX",
        "on_time_pct": 92.7,
        "volume": 6110
      }
    ]
  },
  "meta": {
    "requestId": "\u2026",
    "version": "0.1.0"
  }
}

401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/carriers

On-time by carrier

API key (Bearer token)

X-Organization-Id *

https://api-staging.orderlycore.com/v1/carriers

Single carrier detail

GET/v1/carriers/{carrier}

Live.

Parameters

Name	In	Required	Description
carrier	path	yes	Carrier slug, e.g. ups

Responses

200 Success. Data is returned in the standard { ok, data, meta } envelope.

401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/carriers/{carrier}

Single carrier detail

API key (Bearer token)

carrier * (path)

https://api-staging.orderlycore.com/v1/carriers/

Predicted-vs-actual scorecard

GET/v1/scorecard

Per-shipment predicted vs. actual delivery for the active organization. Requires X-Organization-Id. Live.

Responses

200 Success. Payload wrapped in the standard envelope:

{
  "ok": true,
  "data": {
    "shipments": [
      {
        "tracking_number": "1Z999AA10123456784",
        "carrier": "ups",
        "promised_at": "2026-07-23T23:59:00Z",
        "predicted_at": "2026-07-23T18:20:00Z",
        "delivered_at": "2026-07-23T16:45:00Z",
        "on_time": true
      }
    ]
  },
  "meta": {
    "requestId": "\u2026",
    "version": "0.1.0"
  }
}

400 org_required when the X-Organization-Id header is missing. 401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/scorecard

Predicted-vs-actual scorecard

API key (Bearer token)

X-Organization-Id *

https://api-staging.orderlycore.com/v1/scorecard

Facility geo + congestion

GET/v1/map

Live.

Parameters

Name	In	Required	Description
limit	query	no	Max facilities (default 400)

Responses

200 Success. Data is returned in the standard { ok, data, meta } envelope.

401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/map

Facility geo + congestion

API key (Bearer token)

limit (query)

https://api-staging.orderlycore.com/v1/map

Facilities with delay, weather, airport status

GET/v1/network-hubs

Live.

Parameters

Name	In	Required	Description
limit	query	no

Responses

200 Success. Data is returned in the standard { ok, data, meta } envelope.

401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/network-hubs

Facilities with delay, weather, airport status

API key (Bearer token)

limit (query)

https://api-staging.orderlycore.com/v1/network-hubs

Deep learnings for one facility

GET/v1/network-hub-detail

Live.

Parameters

Name	In	Required	Description
id	query	yes	Facility id

Responses

200 Success. Data is returned in the standard { ok, data, meta } envelope.

401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/network-hub-detail

Deep learnings for one facility

API key (Bearer token)

id * (query)

https://api-staging.orderlycore.com/v1/network-hub-detail

ISO weekdays a service delivers

GET/v1/service-calendar

Live.

Parameters

Name	In	Required	Description
carrier	query	yes	Carrier slug
service	query	no	Service code

Responses

200 Success. Data is returned in the standard { ok, data, meta } envelope.

401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/service-calendar

ISO weekdays a service delivers

API key (Bearer token)

carrier * (query)

service (query)

https://api-staging.orderlycore.com/v1/service-calendar

Hub dwell hotspots

GET/v1/hubs

Returns facilities with elevated dwell time and the shipment volume behind each hotspot. Live.

Parameters

Name	In	Required	Description
limit	query	no

Responses

200 Success. Data is returned in the standard { ok, data, meta } envelope.

401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/hubs

Hub dwell hotspots

API key (Bearer token)

limit (query)

https://api-staging.orderlycore.com/v1/hubs

Lane performance

GET/v1/lanes

Returns transit time, volume, reliability, and drift by origin-to-destination lane. Live.

Parameters

Name	In	Required	Description
origin	query	no
dest	query	no
degraded	query	no
limit	query	no

Responses

200 Success. Data is returned in the standard { ok, data, meta } envelope.

401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/lanes

Lane performance

API key (Bearer token)

origin (query)

dest (query)

degraded (query)

limit (query)

https://api-staging.orderlycore.com/v1/lanes

Network drift alerts

GET/v1/alerts

Returns current network alerts, optionally filtered by severity or carrier. Live.

Parameters

Name	In	Required	Description
severity	query	no
carrier	query	no

Responses

200 Success. Data is returned in the standard { ok, data, meta } envelope.

401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/alerts

Network drift alerts

API key (Bearer token)

severity (query)

carrier (query)

https://api-staging.orderlycore.com/v1/alerts

Service catalog + delivery calendars

GET/v1/services

Returns carrier services and their delivery-calendar details. Live.

Responses

200 Success. Data is returned in the standard { ok, data, meta } envelope.

401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/services

Service catalog + delivery calendars

API key (Bearer token)

https://api-staging.orderlycore.com/v1/services

On-time by carrier/service

GET/v1/metrics/on-time

Returns on-time performance by carrier and service for the selected period. Live.

Parameters

Name	In	Required	Description
carrier	query	no
from	query	no
to	query	no

Responses

200 Success. Data is returned in the standard { ok, data, meta } envelope.

401 Missing or invalid bearer token. 429 Rate limit exceeded.

GET/v1/metrics/on-time

On-time by carrier/service

API key (Bearer token)

carrier (query)

from (query)

to (query)

https://api-staging.orderlycore.com/v1/metrics/on-time