Shopify

{
  "description": "Build Shopify applications, extensions, and themes using GraphQL/REST APIs, Shopify CLI, Polaris UI components, and Liquid templating. Capabilities include app development with OAuth authentication, checkout UI extensions for customizing checkout flow, admin UI extensions for dashboard integration, POS extensions for retail, theme development with Liquid, webhook management, billing API integration, product/order/customer management. Use when building Shopify apps, implementing checkout customizations, creating admin interfaces, developing themes, integrating payment processing, managing store data via APIs, or extending Shopify functionality.",
  "references": {
    "files": [
      "references/app-development.md",
      "references/extensions.md",
      "references/themes.md"
    ]
  },
  "content": "Comprehensive guide for building on Shopify platform: apps, extensions, themes, and API integrations.\r\n\r\n\r\n### Prerequisites\r\n\r\n```bash\r\nnpm install -g @shopify/cli@latest\r\n\r\nshopify version\r\n```\r\n\r\n### Create New App\r\n\r\n```bash\r\nshopify app init\r\n\r\nshopify app dev\r\n\r\nshopify app generate extension --type checkout_ui_extension\r\n\r\nshopify app deploy\r\n```\r\n\r\n### Theme Development\r\n\r\n```bash\r\nshopify theme init\r\n\r\nshopify theme dev\r\n\r\nshopify theme pull --live\r\n\r\n\r\n### 1. App Development\r\n\r\n**Setup:**\r\n```bash\r\nshopify app init\r\ncd my-app\r\n```\r\n\r\n**Configure Access Scopes** (`shopify.app.toml`):\r\n```toml\r\n[access_scopes]\r\nscopes = \"read_products,write_products,read_orders\"\r\n```\r\n\r\n**Start Development:**\r\n```bash\r\nshopify app dev  # Starts local server with tunnel\r\n```\r\n\r\n**Add Extensions:**\r\n```bash\r\nshopify app generate extension --type checkout_ui_extension\r\n```\r\n\r\n**Deploy:**\r\n```bash\r\nshopify app deploy  # Builds and uploads to Shopify\r\n```\r\n\r\n### 2. Extension Development\r\n\r\n**Available Types:**\r\n- Checkout UI - `checkout_ui_extension`\r\n- Admin Action - `admin_action`\r\n- Admin Block - `admin_block`\r\n- POS UI - `pos_ui_extension`\r\n- Function - `function` (discounts, payment, delivery, validation)\r\n\r\n**Workflow:**\r\n```bash\r\nshopify app generate extension\r\nshopify app dev  # Test locally\r\nshopify app deploy  # Publish\r\n```\r\n\r\n### 3. Theme Development\r\n\r\n**Setup:**\r\n```bash\r\nshopify theme init\r\n```\r\n\r\n**Local Development:**\r\n```bash\r\nshopify theme dev",
  "name": "shopify",
  "id": "shopify_mrgoonie",
  "sections": {
    "Quick Start": "shopify theme push --development\r\n```",
    "Platform Overview": "**Core Components:**\r\n- **Shopify CLI** - Development workflow tool\r\n- **GraphQL Admin API** - Primary API for data operations (recommended)\r\n- **REST Admin API** - Legacy API (maintenance mode)\r\n- **Polaris UI** - Design system for consistent interfaces\r\n- **Liquid** - Template language for themes\r\n\r\n**Extension Points:**\r\n- Checkout UI - Customize checkout experience\r\n- Admin UI - Extend admin dashboard\r\n- POS UI - Point of Sale customization\r\n- Customer Account - Post-purchase pages\r\n- Theme App Extensions - Embedded theme functionality",
    "When to Build What": "### Build an App When:\r\n- Integrating external services\r\n- Adding functionality across multiple stores\r\n- Building merchant-facing admin tools\r\n- Managing store data programmatically\r\n- Implementing complex business logic\r\n- Charging for functionality\r\n\r\n### Build an Extension When:\r\n- Customizing checkout flow\r\n- Adding fields/features to admin pages\r\n- Creating POS actions for retail\r\n- Implementing discount/payment/shipping rules\r\n- Extending customer account pages\r\n\r\n### Build a Theme When:\r\n- Creating custom storefront design\r\n- Building unique shopping experiences\r\n- Customizing product/collection pages\r\n- Implementing brand-specific layouts\r\n- Modifying homepage/content pages\r\n\r\n### Combination Approach:\r\n**App + Theme Extension:**\r\n- App handles backend logic and data\r\n- Theme extension provides storefront UI\r\n- Example: Product reviews, wishlists, size guides",
    "Troubleshooting": "**Rate Limit Errors:**\r\n- Monitor `X-Shopify-Shop-Api-Call-Limit` header\r\n- Implement exponential backoff\r\n- Use bulk operations for large datasets\r\n\r\n**Authentication Failures:**\r\n- Verify access token validity\r\n- Check required scopes granted\r\n- Ensure OAuth flow completed\r\n\r\n**Extension Not Appearing:**\r\n- Verify extension target correct\r\n- Check extension published\r\n- Ensure app installed on store\r\n\r\n**Webhook Not Receiving:**\r\n- Verify webhook URL accessible\r\n- Check signature validation\r\n- Review logs in Partner Dashboard",
    "Reference Documentation": "Detailed guides for advanced topics:\r\n\r\n- **[App Development](references/app-development.md)** - OAuth, APIs, webhooks, billing\r\n- **[Extensions](references/extensions.md)** - Checkout, Admin, POS, Functions\r\n- **[Themes](references/themes.md)** - Liquid, sections, deployment",
    "Development Workflow": "```\r\n\r\n**Deployment:**\r\n```bash\r\nshopify theme push --development  # Push to dev theme\r\nshopify theme publish --theme=123  # Set as live\r\n```",
    "Essential Patterns": "### GraphQL Product Query\r\n\r\n```graphql\r\nquery GetProducts($first: Int!) {\r\n  products(first: $first) {\r\n    edges {\r\n      node {\r\n        id\r\n        title\r\n        handle\r\n        variants(first: 5) {\r\n          edges {\r\n            node {\r\n              id\r\n              price\r\n              inventoryQuantity\r\n            }\r\n          }\r\n        }\r\n      }\r\n    }\r\n    pageInfo {\r\n      hasNextPage\r\n      endCursor\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n### Checkout Extension (React)\r\n\r\n```javascript\r\nimport { reactExtension, BlockStack, TextField, Checkbox } from '@shopify/ui-extensions-react/checkout';\r\n\r\nexport default reactExtension('purchase.checkout.block.render', () => <Extension />);\r\n\r\nfunction Extension() {\r\n  const [message, setMessage] = useState('');\r\n\r\n  return (\r\n    <BlockStack>\r\n      <TextField label=\"Gift Message\" value={message} onChange={setMessage} />\r\n    </BlockStack>\r\n  );\r\n}\r\n```\r\n\r\n### Liquid Product Display\r\n\r\n```liquid\r\n{% for product in collection.products %}\r\n  <div class=\"product-card\">\r\n    <img src=\"{{ product.featured_image | img_url: 'medium' }}\" alt=\"{{ product.title }}\">\r\n    <h3>{{ product.title }}</h3>\r\n    <p>{{ product.price | money }}</p>\r\n    <a href=\"{{ product.url }}\">View Details</a>\r\n  </div>\r\n{% endfor %}\r\n```",
    "Resources": "**Official Documentation:**\r\n- Shopify Docs: https://shopify.dev/docs\r\n- GraphQL API: https://shopify.dev/docs/api/admin-graphql\r\n- Shopify CLI: https://shopify.dev/docs/api/shopify-cli\r\n- Polaris: https://polaris.shopify.com\r\n\r\n**Tools:**\r\n- GraphiQL Explorer (Admin → Settings → Apps → Develop apps)\r\n- Partner Dashboard (app management)\r\n- Development stores (free testing)\r\n\r\n**API Versioning:**\r\n- Quarterly releases (YYYY-MM format)\r\n- Current: 2025-01\r\n- 12-month support per version\r\n- Test before version updates\r\n\r\n---\r\n\r\n**Note:** This skill covers Shopify platform as of January 2025. Refer to official documentation for latest updates.",
    "Best Practices": "**API Usage:**\r\n- Prefer GraphQL over REST for new development\r\n- Request only needed fields to reduce costs\r\n- Implement pagination for large datasets\r\n- Use bulk operations for batch processing\r\n- Respect rate limits (cost-based for GraphQL)\r\n\r\n**Security:**\r\n- Store API credentials in environment variables\r\n- Verify webhook signatures\r\n- Use OAuth for public apps\r\n- Request minimal access scopes\r\n- Implement session tokens for embedded apps\r\n\r\n**Performance:**\r\n- Cache API responses when appropriate\r\n- Optimize images in themes\r\n- Minimize Liquid logic complexity\r\n- Use async loading for extensions\r\n- Monitor query costs in GraphQL\r\n\r\n**Testing:**\r\n- Use development stores for testing\r\n- Test across different store plans\r\n- Verify mobile responsiveness\r\n- Check accessibility (keyboard, screen readers)\r\n- Validate GDPR compliance",
    "Scripts": "**[shopify_init.py](scripts/shopify_init.py)** - Initialize Shopify projects interactively\r\n```bash\r\npython scripts/shopify_init.py\r\n```"
  }
}

---
name: shopify
description: Build Shopify applications, extensions, and themes using GraphQL/REST APIs, Shopify CLI, Polaris UI components, and Liquid templating. Capabilities include app development with OAuth authentication, checkout UI extensions for customizing checkout flow, admin UI extensions for dashboard integration, POS extensions for retail, theme development with Liquid, webhook management, billing API integration, product/order/customer management. Use when building Shopify apps, implementing checkout customizations, creating admin interfaces, developing themes, integrating payment processing, managing store data via APIs, or extending Shopify functionality.
---

# Shopify Development

Comprehensive guide for building on Shopify platform: apps, extensions, themes, and API integrations.

## Platform Overview

**Core Components:**
- **Shopify CLI** - Development workflow tool
- **GraphQL Admin API** - Primary API for data operations (recommended)
- **REST Admin API** - Legacy API (maintenance mode)
- **Polaris UI** - Design system for consistent interfaces
- **Liquid** - Template language for themes

**Extension Points:**
- Checkout UI - Customize checkout experience
- Admin UI - Extend admin dashboard
- POS UI - Point of Sale customization
- Customer Account - Post-purchase pages
- Theme App Extensions - Embedded theme functionality

## Quick Start

### Prerequisites

```bash
# Install Shopify CLI
npm install -g @shopify/cli@latest

# Verify installation
shopify version
```

### Create New App

```bash
# Initialize app
shopify app init

# Start development server
shopify app dev

# Generate extension
shopify app generate extension --type checkout_ui_extension

# Deploy
shopify app deploy
```

### Theme Development

```bash
# Initialize theme
shopify theme init

# Start local preview
shopify theme dev

# Pull from store
shopify theme pull --live

# Push to store
shopify theme push --development
```

## Development Workflow

### 1. App Development

**Setup:**
```bash
shopify app init
cd my-app
```

**Configure Access Scopes** (`shopify.app.toml`):
```toml
[access_scopes]
scopes = "read_products,write_products,read_orders"
```

**Start Development:**
```bash
shopify app dev  # Starts local server with tunnel
```

**Add Extensions:**
```bash
shopify app generate extension --type checkout_ui_extension
```

**Deploy:**
```bash
shopify app deploy  # Builds and uploads to Shopify
```

### 2. Extension Development

**Available Types:**
- Checkout UI - `checkout_ui_extension`
- Admin Action - `admin_action`
- Admin Block - `admin_block`
- POS UI - `pos_ui_extension`
- Function - `function` (discounts, payment, delivery, validation)

**Workflow:**
```bash
shopify app generate extension
# Select type, configure
shopify app dev  # Test locally
shopify app deploy  # Publish
```

### 3. Theme Development

**Setup:**
```bash
shopify theme init
# Choose Dawn (reference theme) or start fresh
```

**Local Development:**
```bash
shopify theme dev
# Preview at localhost:9292
# Auto-syncs to development theme
```

**Deployment:**
```bash
shopify theme push --development  # Push to dev theme
shopify theme publish --theme=123  # Set as live
```

## When to Build What

### Build an App When:
- Integrating external services
- Adding functionality across multiple stores
- Building merchant-facing admin tools
- Managing store data programmatically
- Implementing complex business logic
- Charging for functionality

### Build an Extension When:
- Customizing checkout flow
- Adding fields/features to admin pages
- Creating POS actions for retail
- Implementing discount/payment/shipping rules
- Extending customer account pages

### Build a Theme When:
- Creating custom storefront design
- Building unique shopping experiences
- Customizing product/collection pages
- Implementing brand-specific layouts
- Modifying homepage/content pages

### Combination Approach:
**App + Theme Extension:**
- App handles backend logic and data
- Theme extension provides storefront UI
- Example: Product reviews, wishlists, size guides

## Essential Patterns

### GraphQL Product Query

```graphql
query GetProducts($first: Int!) {
  products(first: $first) {
    edges {
      node {
        id
        title
        handle
        variants(first: 5) {
          edges {
            node {
              id
              price
              inventoryQuantity
            }
          }
        }
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}
```

### Checkout Extension (React)

```javascript
import { reactExtension, BlockStack, TextField, Checkbox } from '@shopify/ui-extensions-react/checkout';

export default reactExtension('purchase.checkout.block.render', () => <Extension />);

function Extension() {
  const [message, setMessage] = useState('');

  return (
    <BlockStack>
      <TextField label="Gift Message" value={message} onChange={setMessage} />
    </BlockStack>
  );
}
```

### Liquid Product Display

```liquid
{% for product in collection.products %}
  <div class="product-card">
    <img src="{{ product.featured_image | img_url: 'medium' }}" alt="{{ product.title }}">
    <h3>{{ product.title }}</h3>
    <p>{{ product.price | money }}</p>
    <a href="{{ product.url }}">View Details</a>
  </div>
{% endfor %}
```

## Best Practices

**API Usage:**
- Prefer GraphQL over REST for new development
- Request only needed fields to reduce costs
- Implement pagination for large datasets
- Use bulk operations for batch processing
- Respect rate limits (cost-based for GraphQL)

**Security:**
- Store API credentials in environment variables
- Verify webhook signatures
- Use OAuth for public apps
- Request minimal access scopes
- Implement session tokens for embedded apps

**Performance:**
- Cache API responses when appropriate
- Optimize images in themes
- Minimize Liquid logic complexity
- Use async loading for extensions
- Monitor query costs in GraphQL

**Testing:**
- Use development stores for testing
- Test across different store plans
- Verify mobile responsiveness
- Check accessibility (keyboard, screen readers)
- Validate GDPR compliance

## Reference Documentation

Detailed guides for advanced topics:

- **[App Development](references/app-development.md)** - OAuth, APIs, webhooks, billing
- **[Extensions](references/extensions.md)** - Checkout, Admin, POS, Functions
- **[Themes](references/themes.md)** - Liquid, sections, deployment

## Scripts

**[shopify_init.py](scripts/shopify_init.py)** - Initialize Shopify projects interactively
```bash
python scripts/shopify_init.py
```

## Troubleshooting

**Rate Limit Errors:**
- Monitor `X-Shopify-Shop-Api-Call-Limit` header
- Implement exponential backoff
- Use bulk operations for large datasets

**Authentication Failures:**
- Verify access token validity
- Check required scopes granted
- Ensure OAuth flow completed

**Extension Not Appearing:**
- Verify extension target correct
- Check extension published
- Ensure app installed on store

**Webhook Not Receiving:**
- Verify webhook URL accessible
- Check signature validation
- Review logs in Partner Dashboard

## Resources

**Official Documentation:**
- Shopify Docs: https://shopify.dev/docs
- GraphQL API: https://shopify.dev/docs/api/admin-graphql
- Shopify CLI: https://shopify.dev/docs/api/shopify-cli
- Polaris: https://polaris.shopify.com

**Tools:**
- GraphiQL Explorer (Admin → Settings → Apps → Develop apps)
- Partner Dashboard (app management)
- Development stores (free testing)

**API Versioning:**
- Quarterly releases (YYYY-MM format)
- Current: 2025-01
- 12-month support per version
- Test before version updates

---

**Note:** This skill covers Shopify platform as of January 2025. Refer to official documentation for latest updates.