OriginsNext provides a suite of public APIs for system-to-system integration. These APIs follow a versioning strategy to ensure stable integrations while continuously delivering new features and improvements.
Why API versioning matters?
Clients to adopt new features at their own pace
Predictable upgrade timelines when changes may break existing integrations
Key terms
Term | Definition |
Current version | Actively supported version with the latest features and improvements |
Deprecated | Still supported but will be retired after a defined period |
Breaking change | Any change to the API contract (path, request, response, or behaviour) that may affect current integrations |
Important: A new API version is only introduced if there is a breaking change.
Support for deprecated versions once a new version is released:
The previous version becomes deprecated
Deprecated versions remain supported for at least 3 months
Example:
If version v1 was released on 1 Jan 2024 and v2 was released on 1 Mar 2024, clients using v1 will be supported until at least 2 Jun 2024.
How to upgrade to the latest version?
OriginsNext uses path-based versioning (e.g., /v3/your-endpoint). Follow the steps below to upgrade:
Open the API documentation specific to the endpoint you are using (e.g., Movements Production API)
Check the version number at the top-right corner of the documentation
If your current version is outdated, locate the section detailing breaking changes
Review changes introduced in newer versions to understand what may need updating in your integration logic
Once ready, update your integration URL to the new version (e.g., change from /v2/ to /v3/)
Test the integration with the Sandbox environment before moving to production
You can find Sandbox URLs in the API documentation
Note: Each API documentation page is versioned. Breaking changes listed are relative to the previous version.