Skip to main content

API Reference

The Hub REST API is served at https://api.orderly-hub.com under /api/v1, authenticated with a bearer token (oh_... API key or user JWT). Use the Try it consoles to send a live request against the Preview (test) server. Enter your key and press Send.

info

The console runs from your browser against api-test.orderly-hub.com. Your key is sent only to the selected server.

Conventions​

  • Pagination: list endpoints return { data: [...], pagination: { page, limit, total } }.
  • Filtering: most lists accept status, since, search, and include.
  • Errors: non-2xx responses return { error: { code, message } }.

Explore​

  • Orders: list, read, and manage orders
  • Shipments: shipments, tracking, and labels
  • Bridges: connected integrations and their status

The full machine-readable spec is published at /openapi/v1.json.