API Deprecation at Shopify: 2022-01 Edition

Welcome to another edition of API deprecations at Shopify, where we dive into the breaking changes coming into effect for all supported versions. In this edition, we'll review the breaking changes in the 2021-04 API version, the oldest supported version as of January 1, 2022. This includes vital information for developers of private apps. Let's take a look.

A quick refresher on versioning

Before we dive into the changes headed your way, let's revisit howAPI versioning at Shopifyworks.

• We release a version every quarter. These releases typically happen on or around January 1, April 1, July 1, and October 1. Versions are named in a year-month format (e.g. 2022-01), ensuring that it will always be easy to identify the time the version became stable, as well as compare the timelines of multiple versions.
• Apps make requests to a specific version of the API by specifying it in the request URL. While the Shopify APIs continuously evolve, apps can be built on a stable version to ensure that the API contract remains constant. Keep in mind this means that any features released after your targeted version won't be accessible until you update your request URL.
• 我们商人不断释放特性。来ship features without affecting the latest stable APIs, we use release candidates. The release candidate is simply the next API version, and can be targeted for requests using the same year-month format. In the release candidate, you'll find the latest set of features that have just been released. However, since it's continuously evolving, you should avoid using the release candidate for your app's general everyday consumption of the API. To have both the benefit of stability and access to the latest features, we recommend keeping your app's everyday requests on a stable version, and only moving specific calls that deal with newly released features to the release candidate.
• 不请求一个特定版本的应用程序rved the oldest supported version. This allowed existing apps to continue functioning when we shipped versioning, without having to update to the new URLs. This concept also applies to apps explicitly calling versions that are no longer supported. While every app will benefit from this mechanism preventing all of their requests from erroring out after a version switch, we recommend targeting recent releases intentionally.
• Versions are supported for one year. Removing support for versions allows us to stay agile and make the changes needed to best serve our merchants and the Shopify platform for the long term. While versions are supported for one year, this means that apps actually only have nine months to adopt these new changes and take advantage of new features before the old behavior is no longer available.

With this refresher at the top of our mind, let's review the key information you'll need to be ready for January 1, 2022.

What’s happening on January 1

On January 1, 2022, the following changes will come into effect on our APIs for both public and private apps:

• The 2022-01 version will become stable and ready for general usage.
• The 2021-01 version will become unsupported.
• Requests that have been deprecated by changes in 2021-04 will cause your app to be flagged. To minimize merchant impact, Shopify will de-list flagged apps from theShopify App Storeand block new installs. Additionally, we may notify merchants that your apps are no longer supported.

Shortly afterward, at our discretion:

• Requests with no API version specified will be served the2021-04 version.
• Requests for the 2021-01 version will no longer receive that version. Instead, these requests will fall forward to2021-04.
• Webhooks set to 2021-01 will fall forward in the same manner.

Most importantly, the 2021-04 API version, which will become the default version, includes breaking API changes. If your app is making requests that would break in 2021-01, you need to take action and migrate those requests before January 1, 2022. Failure to do so will result in failed requests and a broken app.

Upcoming breaking changes

Below are the breaking changes introduced in 2021-04, which will become Shopify’s oldest supported version on January 1, 2022.

下一步行动付款应用程序

As of API version 2021-04, payment apps that use theredirectUrlfield onPaymentSessionmust update their apps to use thenextActionfield.

Previously, payment apps that were processing a payment needed to use theredirectUrlfield to redirect the customer after they completed their payment offsite. ThisredirectUrlfield was specific to offsite payments only.

来support payment methods other than offsite, and other actions that might need to occur depending on the type of payment, we've added the following fields onPaymentSessionNextAction:

• action: The action that the payment app must perform.REDIRECTindicates the need to redirect the customer after they've completed their payment andnilspecifies that no next action is required to complete the payment process.
• context: Any data required to perform the action. Currently,contextcan only bePaymentSessionActionsRedirect.

Get ready for January 1, 2022

The following resources can help you stay on top of changes to the Shopify platform:

• API health report: A per-app health report in thePartner Dashboardthat showcases the exact API changes that will affect you.
• Email: Ensure your developer contact email is up-to-date so we can notify you about pending changes.
• Deprecation headers: In your app, theX-Shopify-API-Deprecated-Reasonheader is added to requests that are deprecated and will be unsupported within nine months.
• Developer changelog: Stay up to date with the recent changes to Shopify’s APIs and other developer products
• Deprecated API calls endpoint: Private apps can access their API health information via this endpoint.

Check out the2022-01 release notesfor the full set of new features, yourPartner Dashboardto see which changes may affect you, or subscribe to our monthly What’s New for Shopify Developers and Partners newsletter below.