Shopify API deprecation practices

Functionality in Shopify's APIs can be deprecated if it becomes unnecessary, unsafe, or outdated. When an API action, attribute, or property is marked as deprecated, your app can still use it, but you'll receive warnings to stop using it. In most cases, it will be removed from the API after a period of time, which will cause your app to stop working if it still uses the deprecated functionality.

Shopify uses several deprecation practices to help you be aware of upcoming deprecations and to give you time to transition your apps.

GraphQL API deprecation practices

When Shopify deprecates a field in the GraphQL API, the change will be communicated in one or more of the following ways:

  • Calls that include the field will return the response header X-Shopify-API-Deprecated-Reason.
  • A deprecation warning for the field will be shown in API client tools, such as Shopify's GraphQL Explorer:

A warning on a deprecated field in GraphiQL.

REST API deprecation practices

When Shopify deprecates a resource or a property of a resource in the REST Admin API, the change will be communicated in one or more of the following ways:

  • Calls that include the resource or property will return the response header X-Shopify-API-Deprecated-Reason.
  • A notice about the deprecation will be posted in the API Announcements forum, or the API changelog.
  • The REST Admin API reference will be updated to identify the affected resource and any action you need to take.
  • If there is an imminent breaking change that will affect your app, then the emergency developer contact for your app could be notified about the deprecation.

Sign up for a Partner account to get started.

Sign up