How do I keep up with Shopify's quarterly API versions without breaking merchant stores?
Shopify releases API versions every quarter and retires old ones on a schedule. Falling behind can break apps.
- We're on an old API version.
- How often do we need to update?
- How do we avoid breaking stores?
Shopify releases a new API version quarterly, and each stable version is supported for at least 12 months. Put the release and retirement dates on your calendar, watch deprecation notices in your Partner dashboard and changelog, and upgrade at least twice a year. Test on development stores with automated tests, then roll out in stages. Monitor errors after each release.
Upgrade routine
| Step | What |
|---|---|
| Read changelog | Breaking changes for your endpoints |
| Check deprecations | Partner dashboard notices |
| Update and test | Dev stores, automated tests |
| Roll out | Staged, with monitoring |
How we look at it at ShoutEx
Our developers maintain apps, upgrade API versions and set up tests and monitoring.
- Ignoring deprecation notices.
- Upgrading the week before retirement.
- No tests.
- Big-bang releases.
- Calendar of dates.
- Regular upgrades.
- Automated tests.
- Staged rollouts.
What developers and Shopify say
Here is what Shopify and developers say.
Shopify's official versioning schedule and support window.
Read the docs →Community summaries describe recurring themes in public threads, not individual posts. Vendor pages describe vendor claims, so test them on your own calls.
Read next
Go deeper in the ShoutEx guides, or check the sources behind this answer.
We'll maintain your app and set up tests.
Book a call →Follow-up questions
What happens if we fall behind?
Requests may fall forward to a newer version and break.
Should we use GraphQL?
Shopify is moving new features to GraphQL.
How long does an upgrade take?
Depends on changes. Scope each quarter.