API versioning enables continuous usage enhancements and capability advancements, while offering integrators a predictable path for feature upgrades and deprecations.
Version overview
The current release status of each version of the APIs.
Admin API
Storefront API
Available APIs
Voyado Elevate has two APIs that are versioned independently.
- New versions of either API can be released separately
- Any version of the Admin API can be used with any version of the Storefront API
- Breaking changes are always released as new versions
- Non-breaking changes are automatically applied to the latest version
API structure
The path pattern of the APIs is as follows: /api/{api-name}/v{major}/{resource}, for example:
/api/storefront/v3/queries/search-page/api/admin/v4/status
The path for all resources within each API is affected by a new API release. Structure the integration accordingly to facilitate upgrades.
Release cadence
New versions of either API are targeted to be released at most twice a year. The version number is incremented with each release and is communicated in the changelog as well as the API overview upon release.
Release status
An API version will have one of three release statuses: Current, Active LTS, or End of life.
Current
A newly released version of an API is given the release status Current. This status will be kept until a new version of the API is released.
Active LTS
Upon release of a new version, the previous version of that API will enter Active LTS. LTS, “long-term support,” typically guarantees that critical bugs will be fixed and lasts for 18 months. When a version enters Active LTS, the End of life date will be declared.
End of life
To focus efforts on more and improved capabilities, versions that have reached End of life will no longer be supported. Removal of support will always be rolled out in a controlled and safe manner, ensuring awareness of potential usage and timelines. 
