Orbit Docs

For Non-Technical Managers and Business Departments: Discover high-level overviews, practical use-case scenarios, and the tangible benefits of Orbit, presented in an easy-to-understand format → Orbit Docs.

Environments

The Orbit API can be used in two environments: staging and production. The staging environment is for testing, while the production environment is used to interact with the live system. A dedicated account and API key is needed for each environment.

Authentication

Like many modern APIs, the Orbit API mandates the inclusion of an API key within the request header. You can generate and administer API keys via the settings section in MissionControl.

The API key should be supplied as the value for the X-API-KEY field within the request header::

curl --request POST \
     --url https://api.orbit.do/v5/shipments \
     --header 'Content-Type: application/json' \
     --header 'X-API-KEY: YourKeyHere'

If you have any questions regarding the Orbit API, feel free to contact Orbit customer support.

Units & formatting

Unit	Formatting
Dates & Times	Unix epoch timestamp (seconds, GMT)
Monetary Values	Eurocent (1 Euro = 100 Cent)
Heights, Lengths & Widths	cm
Weights	kg
Coordinates	Decimal Degrees (DD)
Countries	We highly recommend to use ISO 3166-1 alpha-3 codes to identify countries (e.g. DEU). While the system also accepts other formats like ISO 3166-1 alpha-2 and even localized names, some functionality might not work as expected.