Shopify releases quarterly API updates and regularly deprecates older endpoints, webhooks, and extensions. Keeping track of these changes manually — by reading every Shopify developer blog post or changelog entry — is slow and easy to miss. Meridian’s Shopify API Alerts feature monitors the Shopify developer changelog and automatically surfaces the entries that are relevant to your app, classified by severity and impact area, so you can act on the changes that matter without sifting through the ones that don’t.Documentation Index
Fetch the complete documentation index at: https://help.the-meridian.ai/llms.txt
Use this file to discover all available pages before exploring further.
How it works
Meridian reads the Shopify developer changelog and runs each entry through an AI classifier. The classifier assesses the entry against your app’s codebase and produces an alert that tells you:- Whether the change affects your app — alerts are marked as relevant or not relevant to your specific implementation.
- How urgent the change is — a severity level of
critical,warning, orinfo. - Where in your code the affected API is used — file paths, line numbers, and code snippets showing exactly where you’re calling the deprecated or changed API.
- What to do — a migration recommendation and, where applicable, a migration deadline.
Alerts are scoped to the app you have selected in Meridian. If you manage multiple apps, switch apps from the top navigation to see alerts for each one.
The alerts dashboard
Navigate to Shopify API Alerts in the Meridian sidebar. The dashboard shows a stats bar at the top and a list of alerts below.Stats bar
The stats bar gives you an at-a-glance view of your alert status:| Stat | Description |
|---|---|
| Total | Total number of alerts across all severities. |
| Critical | Alerts that require immediate action — typically breaking changes or deprecations with an imminent deadline. |
| Warning | Alerts that require action before a future API version cutoff. |
| Info | Informational alerts about new API versions or non-breaking additions. |
| Unacknowledged | Alerts you haven’t reviewed yet. |
| Action required | Alerts where Meridian’s classifier determined that your code must be updated. |
Filtering alerts
Use the filter controls to narrow the alert list:- Severity — filter by
critical,warning, orinfo. - Tag — filter by the area of Shopify’s platform the change affects (see Change tags below).
- API version — filter by a specific Shopify API version (e.g.,
2026-04,2026-01,2025-10). - Acknowledgement status — show all alerts, only unacknowledged, or only acknowledged.
- Search — free-text search across alert titles and summaries.
Acknowledging alerts
Open any alert to read its full details. Once you’ve reviewed an alert and decided how to handle it, click Acknowledge to mark it as reviewed. Acknowledged alerts are stamped with the time and the user who acknowledged them.Acknowledging an alert doesn’t mean the work is done — it means you’ve reviewed it. Use acknowledgement to track which alerts your team has already assessed, not as a completion marker.
Alert details
Each alert contains two layers of information: the original changelog entry from Shopify, and Meridian’s AI-generated classification.Changelog entry
| Field | Description |
|---|---|
date | When Shopify published the changelog entry. |
title | The title of the changelog entry. |
summary | Shopify’s description of the change. |
tags | Which areas of Shopify’s platform are affected (see Change tags). |
apiVersion | The Shopify API version this change applies to, if specified. |
url | Link to the full entry on the Shopify developer changelog. |
AI classification
| Field | Description |
|---|---|
severity | critical, warning, or info — how urgently you need to act. |
reason | Why this severity was assigned. |
impactAreas | Which functional areas of your app are affected. |
actionRequired | Whether Meridian determined you must make a code change. |
migrationDeadline | If Shopify specified a deadline for migrating away from the deprecated API. |
affectedApis | The specific API endpoints, webhooks, or features that changed. |
recommendation | Meridian’s suggested action to resolve the alert. |
Code references
When Meridian detects that your app uses an affected API, it surfaces code references alongside the alert:| Field | Description |
|---|---|
filePath | The file in your repository that contains the affected code. |
startLine / endLine | The line range where the usage appears. |
snippet | A short code excerpt showing the usage in context. |
description | An explanation of why this line is flagged. |
Change tags
Shopify API Alerts tracks changes across every part of Shopify’s developer platform. Changes are tagged with one or more of the following labels:API surface tags
API surface tags
App surface tags
App surface tags
Platform and tooling tags
Platform and tooling tags
Configuring email notifications
Meridian can send email alerts when new changelog entries are classified for your app. To configure your notification preferences, open your Notification Settings from the user menu.| Setting | Description |
|---|---|
| Enabled | Toggle email alerts on or off. |
| Email address | The address to send notifications to. |
| Severity threshold | Choose critical to only receive the most urgent alerts, critical-warning for high-priority alerts, or all to receive every classified entry. |
| Action required only | When enabled, you only receive emails for alerts where Meridian determined a code change is required. |
Impact areas
Meridian’s classifier maps each alert to the functional areas of your app it affects. Use these to quickly understand the blast radius of a change:authentication · inventory · orders · payments · subscriptions · checkout · themes · webhooks · functions · extensions · cookies · marketing · customers · fulfillment · metafields · discounts · analytics · pos · general
Best practices for staying current
Review critical alerts within 24 hours
Review critical alerts within 24 hours
Critical alerts typically involve breaking changes or deprecations with a firm deadline. Check your alerts dashboard every day during active development, and aim to review critical alerts the same day they appear.
Track migration deadlines proactively
Track migration deadlines proactively
When an alert includes a
migrationDeadline, add it to your project management tool immediately. Shopify enforces these deadlines — apps using deprecated APIs after the cutoff date stop working.Acknowledge alerts as a team habit
Acknowledge alerts as a team habit
If multiple engineers work on your app, establish a rotation for reviewing and acknowledging alerts. Unacknowledged alerts accumulate quickly during busy API release periods.
Upgrade API versions incrementally
Upgrade API versions incrementally
When Shopify releases a new quarterly API version, filter alerts by that version and work through them systematically — critical first, then warnings, then info. Don’t skip versions: each one may introduce changes the next version depends on.
Use code references as your migration starting point
Use code references as your migration starting point
When an alert includes code references, open the flagged files directly from the alert. The snippet and description tell you exactly what needs to change, which is faster than searching your codebase manually.
Related topics
- Pre-submission review — run a full readiness check on your app before submitting to the Shopify App Store, including checks for deprecated API usage.
- Define pricing plans with Plan Builder — configure your app’s billing plans to align with the Shopify billing API.