How to use
- Copy the installation command and review the source package before installing it in your own agent environment.
- Check the source document for required tools, credentials and supported hosts.
- Describe your input and desired deliverable; review the output against the source material.
npx skills add https://github.com/vercel/shop --skill enable-shopify-marketsBefore you start
- Installation does not include a model subscription, API allowance or permission to access your files.
- Repository stars and installation counts describe activity, not an independent quality or security test.
Rendered from the source repository. Headings, examples, code, tables, links, and referenced images are preserved.
Enable Shopify Markets
Add multi-region commerce to the Vercel Shop template. The fresh baseline is one deployment with clean URLs, inline component copy and reusable functions in lib/content/index.ts, and explicit shopConfig.localization = { country: "US", language: "EN", locale: "en-US" }. It does not include next-intl, catalogs, lib/i18n/, or a lib/params/server.ts locale resolver.
Copy translation and commerce market selection are separate concerns. This skill's regional-locale strategy deliberately combines them: a validated en-US, en-CA, or fr-CA selects translated copy plus Shopify country/language context. Confirm that coupling fits the store before adopting it. Do not infer a shopper's commerce country merely from a copy locale introduced by enable-i18n. Preserve existing installations that intentionally separate language and country; do not force them into this example model.
For a new regional-locale implementation, do not invent a separate market key, redundant market-to-locale map, currency map, or /market/locale route. Existing custom market models need an explicit migration decision, not automatic removal.
Examples of valid public routing:
- Locale sub-path:
/fr-CA/products/shoe - Invisible cookie routing:
/products/shoefor every locale - Per-domain:
example.ca/fr-CA/products/shoeor a single locale onexample.fr/products/shoe
Never generate redundant paths such as /ca/fr-CA/products/shoe.
Before editing
Read the current versions of:
package.json,lib/config/index.ts,lib/content/index.ts, and inline copy throughout routes and components- Existing
lib/i18n/, catalogs, next-intl plugin/providers, locale resolvers, and localized routes if present; these do not exist on the fresh baseline next.config.tsand any existingproxy.ts- Every Storefront API operation and cache wrapper
- Cart creation, cart actions, and buyer identity updates
- Customer Account auth context
- Agent/chat request payload and tools
- SEO, robots, sitemap, and markdown content-negotiation routes
The template uses Next.js 16 with Cache Components. Read the installed Next.js routing/proxy/root-param docs. Install next-intl only when missing, then read its installed plugin, request-config, and routing APIs before editing.
Classify the installation before proceeding:
- Fresh simplified template: follow the next-intl installation and copy-to-catalog migration in
enable-i18n, then use this skill's selected routing strategy and commerce propagation instead of its copy-only rules. - Already localized/customized: preserve existing catalogs, translations, copy functions not yet migrated, scoped providers, public URLs, domains, cookies, redirects, and commerce/cache contracts. Extend only missing functionality; do not reinstall next-intl blindly, reset supported locales, replace custom copy with template English, or move routes twice.
- Copy-only i18n already enabled: keep its translations and routing. Identify the existing fixed commerce country/language before introducing regional selection. Obtain approval for any new coupling or changed public URLs.
Inventory mixed copy/catalog consumers and retain modules still in use. Preserve intentional operation locale/cache inputs even where presentation does not use them. In a noninteractive run, stop and report unresolved routing or market-model choices rather than choosing for the user.
For any Shopify GraphQL edit, use Shopify AI Toolkit to confirm current API facts and validate the complete operation. Then follow shopify-graphql-reference for this template's placement, transforms, cache role, locale flow, and invalidation.
1. Ask for routing and locales
If the user has not already decided, ask which strategy they want:
- Locale sub-path — one regional locale segment, such as
/en-US/...and/fr-CA/.... - Invisible cookie — all public paths stay clean; next-intl internally rewrites
/products/...to/[locale]/products/...using the locale cookie. - Per-domain — domains select the available/default locale context; paths may be prefixed only when a domain supports multiple languages.
For sub-path routing, ask whether the default locale should be:
as-needed:/products/...for the default and/fr-CA/products/...for othersalways:/en-US/products/...and/fr-CA/products/...
Then ask for the default locale and all enabled locales. Require regional BCP 47 tags with both language and region. For example:
en-US, en-CA, fr-CA, de-DEDo not accept bare language tags such as en or fr for Markets mode. Do not ask for a separate market identifier or currency.
Before choosing invisible cookie routing, state its SEO tradeoff: every locale shares one canonical URL, so search engines and shared links cannot target a specific cookie-selected version. Use locale sub-paths or per-domain URLs when each localized version must be independently indexed.
2. Make regional locales the source of truth
For a fresh regional-locale implementation, create lib/i18n/index.ts with the approved list and seed the initial context from shopConfig.localization. If its explicit country/language and formatting locale disagree, resolve that deliberately instead of deriving a different market silently. For an existing implementation, extend its current source of truth without resetting values.
The following is an example of the opted-in regional-locale model, not a replacement for every store's custom configuration:
import type { Locale } from "./types";
export const locales = ["en-US", "en-CA", "fr-CA"] as const;
export const defaultLocale: Locale = "en-US";
export const enabledLocales: readonly Locale[] = locales;
export const localeSwitchingEnabled = enabledLocales.length > 1;
export const LOCALE_COOKIE_NAME = "NEXT_LOCALE";
export function isEnabledLocale(value: string): value is Locale {
return enabledLocales.some((locale) => locale === value);
}Define Locale in lib/i18n/types.ts as type Locale = (typeof locales)[number] with a type-only import of locales from ./index, and import the contract directly from types.ts. Use lib/i18n/routing/index.ts for universal routing configuration, lib/i18n/navigation/client.ts for client navigation, lib/i18n/request/server.ts for request configuration, lib/i18n/action.ts for locale-switch actions, and lib/params/server.ts for the Server Component root-param resolver. Do not add barrels or forwarding exports. Preserve working module paths in customized installations rather than renaming them solely to match these examples.
Create boundary validation such as isEnabledLocale on the fresh baseline; retain existing isEnabledLocale / resolveLocale behavior where present. Reject unsupported request values instead of casting arbitrary strings to Locale. For the approved regional-locale strategy, derive Shopify context from the validated locale:
import type { CommerceLocale } from "@/lib/config/types";
export function getCountryCode(locale: Locale): CommerceLocale["country"] {
const country = new Intl.Locale(locale).region;
if (country === "US" || country === "CA") return country;
throw new Error(`Unsupported commerce country: ${country}`);
}
export function getLanguageCode(locale: Locale): CommerceLocale["language"] {
const language = new Intl.Locale(locale).language.toUpperCase();
if (language === "EN" || language === "FR") return language;
throw new Error(`Unsupported commerce language: ${language}`);
}
export function getCommerceLocale(locale: Locale): CommerceLocale {
return { country: getCountryCode(locale), language: getLanguageCode(locale) };
}These guards cover only the example locale list above. Extend them deliberately for the store's approved countries and languages; reject unsupported values rather than asserting them into Shopify types. Pass getCommerceLocale(locale) to operation locale options.
Prefer Locale over string for internal routing locale parameters. Request bodies, cookies, headers, route params, and query params remain untrusted strings until validated. Validate the country/language conversion against Shopify's supported values with Shopify AI Toolkit; do not assume uppercasing every BCP 47 language produces a valid Shopify language code.
The transport's operation locale option is a CommerceLocale object ({ country, language } from lib/config/types.ts), not a BCP 47 string. Convert once at the validated commerce boundary and propagate that object through existing operation/cache inputs. Keep the copy/routing Locale string distinct. For an older customized transport, adapt its actual signature instead of replacing it wholesale.
Currency rule
Currency always comes from Shopify's localized response (MoneyV2.currencyCode, cart cost, product prices, etc.). Never infer currency from locale and never add localeCurrency, marketCurrency, or a locale-to-currency lookup.
When UI outside a price object needs a currency code, pass one from fetched Shopify data. If Shopify returns no product or cart from which to derive it, omit currency-specific UI rather than guessing.
3. Install next-intl and migrate copy
Use the enable-i18n section "Introduce next-intl and migrate copy" for the full migration. On a fresh storefront, run pnpm add next-intl, create its request config, and compose createNextIntlPlugin from next-intl/plugin around the existing Next config with the explicit request-config path. Use the existing withShopConfig plugin list when present, preserving conditional withBotId and withEve entries, their order, and the installation's feature settings. Preserve other wrappers, rewrites, and Cache Components settings. Do not apply copy-only commerce rules or force localePrefix: "always" when using this Markets skill.
Build the initial catalog from the installation's actual inline copy, component configuration labels, and reusable functions in lib/content/index.ts. Convert typed interpolation and plural functions to equivalent ICU messages, preserving parameters, zero/one/many behavior, rich text, errors, and accessibility labels. Do not serialize functions or write a custom t() parser. Preserve already translated/customized catalogs rather than regenerating them from the template.
Use server getTranslations() and primitive labels by default. Only interactive leaves that need runtime messages use useTranslations() under narrowly scoped NextIntlClientProvider boundaries. Do not ship full catalogs at the root or pass copy functions across the RSC boundary. Include metadata, error/not-found screens, and formatting in the migration. Remove shared content functions only after all their consumers have migrated; update the installation's AGENTS.md for its now-localized architecture.
Add an explicit message loader and catalog for every enabled copy locale. Reuse a language catalog only intentionally; for example, en-US and en-CA may share en.json while Shopify still receives distinct country contexts. Commerce context does not translate storefront labels automatically.
Validate every generated JSON file and keep keys and interpolation arguments aligned. Agree on temporary fallbacks before publishing a locale with incomplete copy; never silently label fallback English as a complete translation.
4. Configure routing
Create lib/i18n/routing/index.ts and use enabledLocales directly. There is no market mapping layer.
Locale sub-path
import { defineRouting } from "next-intl/routing";
import { defaultLocale, enabledLocales, LOCALE_COOKIE_NAME } from "@/lib/i18n";
export const routing = defineRouting({
defaultLocale,
localeCookie: { name: LOCALE_COOKIE_NAME, sameSite: "lax" },
localePrefix: "as-needed", // or "always"
locales: enabledLocales,
});Use full regional locale prefixes. One segment is enough.
Invisible cookie routing
import { defineRouting } from "next-intl/routing";
import { defaultLocale, enabledLocales, LOCALE_COOKIE_NAME } from "@/lib/i18n";
export const routing = defineRouting({
alternateLinks: false,
defaultLocale,
localeCookie: { name: LOCALE_COOKIE_NAME, sameSite: "lax" },
localeDetection: true,
localePrefix: "never",
locales: enabledLocales,
});localePrefix: "never" keeps the locale segment internal. On a request for /products/shoe, next-intl resolves the cookie (or first-visit language preference/default), then rewrites internally to a route such as /fr-CA/products/shoe. The browser URL stays /products/shoe.
Do not implement a second custom market rewrite on top of this. The internal [locale] segment is an implementation detail, not a public URL.
Per-domain routing
export const routing = defineRouting({
defaultLocale,
domains: [
{ defaultLocale: "en-US", domain: "example.com", locales: ["en-US"] },
{ defaultLocale: "en-CA", domain: "example.ca", locales: ["en-CA", "fr-CA"] },
],
localeCookie: { name: LOCALE_COOKIE_NAME, sameSite: "lax" },
localePrefix: "as-needed",
locales: enabledLocales,
});The domain configuration is routing configuration, not a separate commerce market model. Shopify country and language still derive from the resolved regional locale.
Create lib/i18n/navigation/client.ts only for components that explicitly switch locales:
"use client";
import { createNavigation } from "next-intl/navigation";
import { routing } from "@/lib/i18n/routing";
export const { usePathname, useRouter } = createNavigation(routing);Keep Link from @/components/ui/link for internal links; do not replace it with next-intl's Link. Pass explicit strategy-aware hrefs from the server so ordinary links preserve the selected locale without request-context reads in link components. Keep public paths clean in invisible-cookie mode.
5. Move page routes under app/[locale]/
Move the root layout and all localized pages under app/[locale]/. The locale layout must be the root layout; do not leave app/layout.tsx above it.
Move:
app/layout.tsxtoapp/[locale]/layout.tsx- Page routes such as home, products, collections, search, cart, and account into
app/[locale]/...
Keep these unlocalized at app/:
api/- the assistant's public profile under
agent/ - markdown route handlers under
md/ llms.txt/robots.tssitemap.xml/andsitemap/globals.css,global-error.tsx, and static metadata files
Update typed route generics to include [locale], fix the moved globals.css import, and keep every export of the moved layout, including export const ensureStatic = "prefetch". Export generateStaticParams from the locale root layout using enabledLocales.map((locale) => ({ locale })); Cache Components requires at least one root-param value. Keep request reads behind Suspense, and do not add pages outside app/[locale]/; enable-i18n "Cache Components compatibility" and Step 10 list the resulting build errors and bare-/ behavior. Preserve any existing generation logic and restart dev after route moves to regenerate root-param types.
Do not call setRequestLocale with Cache Components. Resolve locale through the root param so locale becomes an explicit route/cache input.
6. Resolve locale from the root param
Create lib/params/server.ts on the fresh baseline, or extend the existing resolver without overwriting unrelated helpers. This getter is for Server Components only:
import { notFound } from "next/navigation";
import { locale as rootLocale } from "next/root-params";
import { isEnabledLocale } from "@/lib/i18n";
import type { Locale } from "@/lib/i18n/types";
export async function getLocale(): Promise<Locale> {
const value = await rootLocale();
if (!value || !isEnabledLocale(value)) notFound();
return value;
}Create or update lib/i18n/request/server.ts to call getLocale() and load the matching messages. Do not resolve locale by reading cookies or request headers from a cached component. The proxy owns request negotiation; React receives the validated internal route param. Set <html lang> and UI formatting from that locale.
Do not call this root-param getter from Route Handlers or Server Actions: use route context or explicit request/action inputs and validate them at the boundary. Keep API, OAuth, markdown, and chat handling outside the Server Component request config.
7. Extend the proxy
Hydrogen's handlers take their market from the request context's i18n: every cart, predictive search, and account operation they run uses @inContext(country, language) from it. The template pins that context to shopConfig.localization in createCustomerRequestContext (lib/auth/server.ts) and in the server cart seed (lib/cart/server.ts). Accept the validated commerce context in both instead. Resolve the locale in the proxy before Shopify dispatch (resolveRequestLocale below): from the validated locale prefix when the path has one, otherwise from the validated locale cookie (unprefixed handler paths such as /api/cart carry no locale segment), otherwise defaultLocale.
Compose next-intl after the existing Shopify route dispatch and Markdown negotiation, where the template returns NextResponse.next(...). handleShopifyRoutes() returns null synchronously when Hydrogen does not own the pathname, so return its promise when present and run locale negotiation only after it declines the request:
const handleI18n = createMiddleware(routing);
// Keep the existing imports and add NextRequest as a runtime import.
export async function proxy(request: NextRequest): Promise<Response> {
const locale = resolveRequestLocale(request);
const requestContext = createCustomerRequestContext(request, getCommerceLocale(locale));
const shopifyRoute = handleShopifyRoutes({
// Preserve the template's handlers, session manager, and storefront client.
request,
requestContext,
});
if (shopifyRoute) return shopifyRoute;
// Keep the template's Markdown negotiation here, unchanged.
const i18nRequest = new NextRequest(request, {
headers: forwardCustomerRefreshAttempt(
request.nextUrl,
requestContext.getForwardedRequestHeaders(),
),
});
const response = handleI18n(i18nRequest);
requestContext.applyResponseHeaders(response.headers);
return response;
}Preserve the complete Shopify options from the current proxy rather than copying the abbreviated example literally.
Update the matcher. The template's single broad matcher is safe only while the proxy does nothing but Shopify dispatch; with locale negotiation, every request Hydrogen declines is localized, including app Route Handlers, webhooks, robots.txt, sitemaps, llms.txt, and static files. Replace it with Shopify's exact route families, locale-prefixed Shopify endpoints, and a catch-all that skips /api, Eve, Next.js and Vercel internals, and paths with a file extension:
export const config = {
matcher: [
"/api/cart",
"/api/predictive-search",
"/api/mcp",
"/api/ucp/mcp",
"/api/:apiVersion(unstable|2\\d{3}-\\d{2})/graphql.json",
"/__shopify/:path*",
"/.well-known/:path*",
"/agent/:action(handoff|buyer-claims).:format",
"/cart.:format(js|json)",
"/cart/:operation(add|update|change|clear).:format(js|json)",
"/:page(index|search).md",
"/:resource(collections|products)/:handle.md",
"/:locale([a-zA-Z]{2}(?:-[a-zA-Z]{2})?)/agent/:action(handoff|buyer-claims).:format",
"/:locale([a-zA-Z]{2}(?:-[a-zA-Z]{2})?)/cart.:format(js|json)",
"/:locale([a-zA-Z]{2}(?:-[a-zA-Z]{2})?)/cart/:operation(add|update|change|clear).:format(js|json)",
"/((?!api|eve(?:/|$)|_eve_internal(?:/|$)|_next/static|_next/image|_next/data|_vercel|favicon.ico|.*\\..*).*)",
],
};Application Route Handlers such as /api/webhooks/shopify, /api/agent/session, and /api/custom remain owned by Next unless explicitly reserved for Hydrogen. Keep Eve's /eve/v1/ and /_eve_internal/ routes outside locale and Shopify proxy handling. Add exact route families when a new Shopify integration requires proxy handling.
For invisible cookie routing, direct public locale-prefixed URLs should canonicalize back to the clean path. next-intl's never mode handles this; do not expose the internal rewrite destination in links, metadata, or redirects.
8. Propagate locale through commerce
Audit definitions and real callers. Under the opted-in regional-locale model, localized Storefront API operations receive validated locale/context, derive country and language at the commerce boundary, and use Shopify's validated @inContext(country: $country, language: $language). Inspect existing locale and cache inputs before adding arguments. Preserve an explicitly separated country/language model rather than repurposing its copy locale.
This includes:
- products, collections, search, recommendations, and complementary products
- navigation menus added by
enable-shopify-menus - cart creation and cart reads that depend on buyer country
- sitemap and markdown catalog/product output
- agent tools and Storefront MCP calls
Cached functions must receive locale explicitly. Never read the locale cookie, headers(), or cookies() inside a "use cache" function. The locale argument naturally separates cache entries; do not add a parallel market cache key.
Keep locale defaults only at compatibility boundaries where the base single-locale template needs them. Once a route has resolved locale, pass it explicitly rather than silently defaulting deeper in the stack.
Menus
If enable-shopify-menus has added getMenu, pass the validated commerce context as getMenu({ handle, locale }) from every caller; its query already carries @inContext. Without this, navigation remains pinned to the default market.
Customer Account auth
Pass the active validated commerce context into the Shopify/Hydrogen request context instead of pinning it to shopConfig.localization or an older defaultLocale. Preserve locale across login, authorize, refresh, and logout return URLs. Validate any locale carried through OAuth state or URL params.
Chat and agent API
Shop Agent is disabled by default. Preserve that setting; enabling Markets must not enable chat. When chat is enabled, inspect agent/channels/eve.ts, agent/tools/, agent/lib/, and the Shopify connections rather than adding an app-owned chat route or commerce HTTP bridge.
Eve's session routes live outside [locale], and invisible URLs do not reveal locale in the referer. Carry the selected locale explicitly, validate it against the installed locale allowlist during cart setup and in Eve's channel, and pass the validated commerce context to the direct Shopify tools and connections. Client context can describe the page, but must not select an arbitrary cart or an unsupported locale. Do not infer locale from URL segments or fall back unconditionally to defaultLocale.
Agent tools, Shopify connections, product context, cart creation, and navigation outputs must use that validated locale. Keep Next.js request and cache APIs in the storefront; Eve uses the shared uncached Shopify catalog operations and Hydrogen handlers.
Markdown negotiation
After the proxy rewrite, localized page routes have an internal /:locale/... path even in invisible mode. Update getMarkdownPath() and getMarkdownMirrorPath() in lib/markdown/representation/index.ts and the proxy's negotiation so the locale reaches unlocalized app/md/... handlers as a validated query/header value. Preserve ?variant= and search parameters.
9. Switch locale and carry the market to the cart
Cart writes stay in Hydrogen's /api/cart handler; never mutate the cart from a Server Action or a custom route. Because the proxy builds the handler's request context from the selected locale (section 7), the next cart read or write after a switch runs in the new market:
fr-CAtoen-CA: copy and Shopify language change; the country staysCA.en-CAtoen-US: the cart's next Hydrogen operation runs with countryUS.
Use Shopify AI Toolkit to confirm how the store's cart buyer country and pricing follow @inContext on cart operations. If the store requires an explicit buyer-country update, the installed Hydrogen SDK exposes no cart intent for it: report that gap instead of adding a cart mutation outside Hydrogen's handlers.
The selector remains a leaf Client Component. A Server Action in lib/i18n/action.ts may validate the requested locale and set the locale cookie; it never reads or writes the cart. After a country change, call refresh() from useCartActions() so prices and checkout reflect Shopify's response for the new market; do not invalidate public cache tags.
- Sub-path/per-domain: use next-intl's client router to replace the current pathname with
{ locale: nextLocale }, then refresh the cart. - Invisible cookie: call the action, then call
router.refresh()and refresh the cart. The pathname must not change.
Do not offer a separate currency selector unless the store has a Shopify-backed currency choice independent of country. Display currency from cart/product responses.
10. Strategy-specific SEO and sitemap behavior
Locale sub-path or per-domain
Each locale has a distinct indexable URL:
- Canonical points to the current locale URL.
- Emit
hreflangalternates for enabled locale URLs plusx-default. - Emit one sitemap URL per locale with matching XHTML alternates.
- Build URLs from the selected routing strategy; do not assume every strategy uses
/${locale}.
Invisible cookie
All variants share one public URL:
- Canonical is the clean public path.
- Do not emit fake locale-specific
hreflangURLs. - Emit one sitemap URL per resource, not one per locale.
- Keep
alternateLinks: falsein next-intl routing. - Treat localization as personalization. Shared links and crawlers without the user's cookie receive negotiated/default content.
Never put internal /[locale]/... rewrite targets into metadata or sitemap XML.
11. Verification
Run focused checks from the storefront root:
pnpm lint
pnpm buildThen run the app and verify the selected strategy.
All strategies
- Default-language copy matches the pre-migration installation, including custom text, interpolation, plurals, errors, and accessibility labels.
- Every enabled catalog has aligned keys/arguments and scoped client providers; fallback text is not mistaken for completed translation.
- Existing localized installations retain translations, custom routing, and their approved commerce model.
- Report whether the fresh-baseline migration and an existing-localized migration were actually exercised; static checks cannot prove either path's parity.
- Every enabled regional locale produces the expected Shopify country/language context.
- Product and cart currency codes come from Shopify responses.
- Public caches separate localized products, prices, and menus; carts remain uncached.
fr-CAtoen-CAkeeps Shopify countryCAfor the cart.en-CAtoen-USrefreshes the cart with Shopify'sUScontext, and every cart write still goes through/api/cart.- Chat/agent operations receive the explicit validated locale.
- Markdown responses use the same locale as HTML responses.
- Variant and filter query parameters survive switching and rewrites.
Locale sub-path
- Locale URLs serve directly with no
/market/localenesting. - Default-prefix behavior matches
alwaysoras-needed. - Canonical, hreflang, and sitemap URLs are locale-specific.
Invisible cookie
curl -I http://localhost:3000/products/example
curl -I --cookie "NEXT_LOCALE=fr-CA" http://localhost:3000/products/example- Both requests keep
/products/exampleas the public URL. - The cookie-selected response has
<html lang="fr-CA">and Shopify countryCAcontext. - Locale switching changes content/cart context without changing the address bar.
/fr-CA/products/exampledoes not remain a public canonical URL.- Metadata and sitemap contain only clean public paths and no locale alternates.
Per-domain
- Each configured host resolves its allowed/default locales.
- Cross-domain locale switching uses the correct host.
- Canonical and hreflang URLs contain the production domains.




