Skip to content

API Versioning

API versioning enables continuous usage enhancements and capability advancements, while offering integrators a predictable path for feature upgrades and deprecations.

Available API:s

Voyado Elevate two API:s that are versioned independently.

  • New versions of either API can be released separately
  • Any version of Admin API can be used with any version of 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 API:s is as follows /api/{api-name}/v{major}/{resource}, for example:

  • /api/storefront/v3/queries/search-page
  • /api/admin/v3/status

Version variable

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 is targeted to be released at most twice every year. The version number is incremented with each release and is communicated in the changelog as well as the API overview upon release.

Regular updates

Keep up to date with the latest features and releases by subscribing to the changelog.

Release status

An API version will have one of three release statuses, Current, Active LTS or End of life.


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 the efforts on more and improved capabilities, versions that have reached End of life will no longer be supported. Removal of support will however always be rolled out in a controlled and safe manner, ensuring awareness of potential usage and timelines.


This online publication is intellectual property of Voyado Lund AB. Its contents can be duplicated in part or whole, provided that a copyright label is visibly located on each copy and the copy is used in conjunction with the product described within this document.

All information found in these documents has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither Voyado Lund AB nor the authors shall be held liable for possible errors or the consequences thereof.

Software and hardware descriptions cited in these documents might be registered trademarks. All trade names are subject to copyright restrictions and may be registered trademarks. Voyado Lund AB essentially adheres to the manufacturer’s spelling. Names of products and trademarks appearing in this document, with or without specific notation, are likewise subject to trademark and trade protection laws and may thus fall under copyright restrictions.