Skip to main content

End-of-life API version

Detects parsed config and React Router server API versions past the 12-month support window and 30-day grace period.

DetailValue
Check IDEOL_API_VERSION
SeverityLow
How it runsDeterministic scan and agent review

app/shopify.server.ts

const shopify = shopifyApp({
// Past the 12-month support window plus the 30-day grace
// period. Removed fields start returning errors without a
// deploy on your side.
apiVersion: ApiVersion.January24,
});

// The same version is declared in configuration, and the check
// reads both:
//
// # shopify.app.toml
// [webhooks]
// api_version = "2024-01"

Update api_version in shopify.app.toml and the ApiVersion enum in shopify.server.ts.

Move to the latest stable version, rather than the oldest one that's still supported, so that you get the full 12-month support window before you need to update again.

For more detail, see API versioning.

app/shopify.server.ts

const shopify = shopifyApp({
apiVersion: ApiVersion.October26,
});

export const apiVersion = ApiVersion.October26;

// Update both places: the check reads every shopify.app*.toml as
// well as the React Router server declaration.
//
// # shopify.app.toml
// [webhooks]
// api_version = "2026-10"


Was this page helpful?