Skip to main content

API Reference

Every endpoint below is served by the gateway at https://api.orderlycore.com under the /v1 prefix, authenticated with a bearer token. Use the Try it consoles to send a live request against the Preview environment. Enter your token (and organization id where required) and press Send.

Preview requests run from your browser

The console calls the preview gateway directly. Your token stays in the browser and is sent only to the selected server. If a call fails with a network error, retry once and check Orderly status.

GET /v1/overview​

Org-scoped network KPIs: 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.

GET/v1/overview

Network KPIs for the active organization.

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

Response​

{
  "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" }
}

GET /v1/capabilities​

Returns route availability so integrations can feature-detect the API surface.

GET/v1/capabilities

What this gateway exposes, with availability status per route.

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