dev-shopify

Applies Shopify platform conventions for metafields, API throttling, and Built for Shopify compliance.

Updated Mar 14, 2026
One-click install
npx skills add https://github.com/dan10002ht/shopify-template --skill dev-shopify-dan10002ht
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dev-shopify
Source: https://github.com/dan10002ht/shopify-template/tree/main/.claude/skills/dev-shopify
Command: npx skills add https://github.com/dan10002ht/shopify-template --skill dev-shopify-dan10002ht

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Shopify app development involves platform-specific rules that are easy to get wrong: metafield namespaces, GraphQL query cost limits, rate limiting, and strict Built for Shopify review criteria. This Skill encodes those conventions so generated code follows Shopify best practices from the start and avoids common app review rejections. ## Core Features & Use Cases - Metafields & Metaobjects Conventions: Namespace rules ($app: vs custom), type selection, definition-first patterns, and migration scripts for bulk metafield updates. - API Throttle Handling: Throttle-aware GraphQL client with exponential backoff, cost-aware pagination, and Bulk Operations for datasets over 250 items. - Built for Shopify Compliance: Checklists covering performance budgets, Polaris UI requirements, security (OAuth, HMAC, GDPR webhooks), and common app review rejection reasons. - Use Case: When implementing a feature that writes customer loyalty data to metafields, the Skill ensures you create a metafield definition first, use the correct $app: namespace, batch writes with metafieldsSet, and handle THROTTLED errors with backoff. ## Quick Start Ask the AI to implement a Shopify feature such as storing customer loyalty tiers in metafields and have it apply the platform conventions for namespaces, throttling, and BfS compliance.

Frequently Asked Questions about dev-shopify

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I handle Shopify GraphQL API rate limits?

Track extensions.cost in every GraphQL response and retry THROTTLED errors with backoff calculated from throttleStatus restoreRate, capped at 30 seconds and 3 retries. For datasets over 250 items, use Bulk Operations which return results asynchronously as a JSONL file.

When should I use metaobjects instead of metafields in Shopify?

Use metafields for simple key-value data attached to existing resources like products or customers. Use metaobjects when you need 4 or more fields, queryable structured data, or relationships between custom data via mixed_reference fields.

What metafield namespace should a Shopify app use?

Use the reserved $app: namespace for app-owned metafields that merchants cannot edit in admin. Use the custom namespace for merchant-editable metafields, and pin the metafield definition so it appears in the admin UI.

What are the Built for Shopify requirements for app submission?

Key requirements include app load under 3 seconds, 100% Polaris components in admin UI, App Bridge 4.x for navigation and modals, OAuth with HMAC webhook validation, minimum necessary API scopes, and the three mandatory GDPR webhooks: CUSTOMERS_DATA_REQUEST, CUSTOMERS_REDACT, and SHOP_REDACT.

Why do Shopify apps get rejected during app review?

Common rejection reasons include load times over 5 seconds, custom UI instead of Polaris components, missing loading or empty states, exposed API keys in client code, unvalidated webhook signatures, excessive scope requests, and missing GDPR webhooks or privacy policy.

Should I use Shopify REST API or GraphQL API?

Default to GraphQL for lower query cost and flexible data fetching. REST remains appropriate for webhook registration, file uploads, and simple single-resource CRUD operations.