Versioning

A new version of a specific endpoint is released when backwards-incompatible changes are applied. Backwards-compatible changes do not create a new version.

The Storefront API uses URI versioning where the first path segment is the version requested for the endpoint.

We generally try to keep backwards compatibility, however in certain situations it is not possible for us to do so.

Backwards-Compatible Changes

When backwards-compatible changes are made to the Storefront API, no new version is released. Backwards-compatible changes include the following:

• Adding new API resources.
• Adding new optional request parameters.
• Adding new properties to responses.

Backwards-Incompatible Changes

When backwards-incompatible changes are made to the Storefront API, a new version is released. Backwards-incompatible changes include the following:

• Deleting existing API resources.
• Adding new required parameters to existing API methods.
• Removing properties from an existing API response.
• Changing data types of existing properties.