Skip to main content
The SystemService class (accessed via client.system) exposes metadata about the API and a simple health check. Use these for connectivity tests, monitoring, and discovering what the API offers.

getApiInfo

Returns basic information about the API — its name, the current version, and the catalogue of available endpoints. Handy for confirming which version you’re integrating against.
Returns the API name, version, and endpoint catalogue.

getHealth

A lightweight health check. Use it for uptime monitors, readiness probes, or to confirm your network can reach the API before running a larger workflow.
Returns the health status (status: 'ok' when the API is operational).
These endpoints are intentionally minimal and low-cost — safe to poll from monitoring systems. They report API reachability, not the status of any individual shipment.