shopify-graphql-reference

Integrate Shopify GraphQL

Treat Shopify AI Toolkit as authoritative for Shopify documentation, schemas, fields, arguments, enum values, API versions, operation design, and validation. This skill owns only the Vercel Shop integration layer.

Read references/REFERENCE.md before editing.

Delegate Shopify facts first

1. Choose the Shopify API:
   • Use Shopify AI Toolkit's Storefront GraphQL skill for catalog, search, menus, cart, and public metaobject reads.
   • Use its Customer skill for profiles, orders, addresses, and other authenticated customer data.
   • Use its custom-data skill first for metafields or metaobjects.
2. Search current Shopify documentation and validate the complete operation with that skill.
3. Do not copy schema snapshots, field catalogs, or generated API reference into this plugin.
4. If Shopify AI Toolkit is unavailable, use official Shopify documentation and validation tooling; do not guess.

Apply the Vercel Shop conventions

1. Inspect the consuming route before choosing cache behavior. Classify the read as static-shell content, request-time shared content, or private/request-scoped data.
2. Add the operation to the closest file in lib/shopify/operations/; create a file only for a genuinely new domain.
3. Keep #graphql documents static, end them with as const, and use variables for dynamic values so codegen can validate them.
4. Reuse the smallest existing fragment that fits. Extend a shared fragment only when multiple operations need the same selection.
5. Pass locale context through existing country and language helpers when Shopify localizes the result.
6. Keep raw Shopify response types under lib/shopify/**; transform them into provider-independent domain types before presentation.
7. Preserve cache tags and the existing webhook invalidation hierarchy. Do not cache mutations.
8. Never place carts in the Next.js data cache; cart reads are memoized per request via getCart, so cart mutations need no cache invalidation step.

Revalidate both boundaries

1. Validate the final GraphQL document again with Shopify AI Toolkit after fragment and variable changes.
2. Run pnpm --filter template codegen and the local lint, typecheck, build, and affected commerce flows.
3. Report separately:
   • Shopify validation performed;
   • Vercel Shop cache and route role;
   • domain transform and invalidation changes.

Do not present this skill as a Shopify schema source. Shopify AI Toolkit determines what Shopify supports; this skill determines how validated operations fit Vercel Shop.