# API Versioning

> How the Shoplazza Admin API is versioned: the YYYY-MM naming, release cadence, available versions, version sunset, and a checklist for migrating.

Shoplazza's Admin API is versioned so that new features and breaking changes can be introduced without disrupting existing apps. This page explains how versions are named, how often they are released, where to find the available versions, and what to do when you migrate.

## Version naming

Every API request must include a version in the URL path. Versions use the `YYYY-MM` format:

```
https://{shopdomain}.myshoplaza.com/openapi/{version}/{endpoint}
```

For example, the following URL calls the `2025-06` version:

```
https://{shopdomain}.myshoplaza.com/openapi/2025-06/articles
```

## Release cadence

Shoplazza releases a new API version every six months. A new version may add endpoints and fields or change existing behavior. Previous versions keep working until they are retired.

## Available versions

To see every version you can call, open the [API reference](/api/openapi) and use the version dropdown at the top of the page — it always reflects the versions currently available.

## Version sunset

When you call a version that is no longer supported, the request returns a `404` status. Move your app to a supported version before then — use the version dropdown in the [API reference](/api/openapi) to confirm which versions are currently available.

## Migration checklist

When you move your app to a new version:

1. Review the [API Changelog](/changelog) to identify added, changed, or removed endpoints and fields.
2. Test your integration against the new version in a development store.
3. Update the version segment in your request URLs — for example, change `2025-06` to the new version.
4. Roll out gradually and monitor for errors before sending all traffic to the new version.