Claude Cursor opencode Skill

shopify

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 das

LLM Mart · 0 points · 2 views 0 listing impressions 0 install-command copies
Download vodailocz-kilo-kit-mcp-skills_engineering_shopify-0448e6c.zip · 21 KB

Install

skills CLI npx skills add https://github.com/VoDaiLocz/kilo-kit-mcp/tree/main/skills/engineering/shopify
Claude Code claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install vodailocz-kilo-kit-mcp@llmmart
Git git clone https://github.com/VoDaiLocz/kilo-kit-mcp.git

The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole vodailocz/kilo-kit-mcp collection as a plugin from our marketplace. Git is the plain clone.

README

Shopify API Research Documentation

This directory contains comprehensive research and analysis of various APIs for integration purposes.

Contents

Shopify GraphQL Admin API Analysis

File: shopify-graphql-admin-api-analysis.md
Date: 2025-10-25
Status: Complete
Thoroughness: Very Thorough

A comprehensive analysis of Shopify's GraphQL Admin API covering:

  • API overview and capabilities
  • Key features and operations
  • Common query and mutation patterns
  • Best practices and optimization strategies
  • Authentication and security considerations
  • Rate limiting and performance optimization
  • Typical use cases and implementation patterns
  • Troubleshooting guide
  • Code examples in multiple languages
  • Resources and further learning

Key Sections:

  1. Executive Summary
  2. API Overview
  3. Key Features
  4. Common Operations (Queries & Mutations)
  5. API Structure (Types, Connections, Errors)
  6. Best Practices
  7. Typical Use Cases
  8. API Versions and Deprecation
  9. Tools and SDKs
  10. Security Considerations
  11. Performance Optimization
  12. Common Patterns
  13. Troubleshooting
  14. Resources and Further Learning

Size: 1,348 lines, ~26KB


Usage

These documents are intended for:

  • Development planning and architecture decisions
  • Team onboarding and training
  • Integration implementation reference
  • Best practices guidance
  • Troubleshooting support

Maintenance

  • Documents should be reviewed quarterly
  • Update when API versions change
  • Add new findings from implementation experience
  • Keep code examples current with latest SDK versions

Last Updated: 2025-10-25
Maintained By: Claude Code Engineering Team

Skill manifest

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

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

# Verify installation
shopify version

Create New App

# 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

# 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:

shopify app init
cd my-app

Configure Access Scopes (shopify.app.toml):

[access_scopes]
scopes = "read_products,write_products,read_orders"

Start Development:

shopify app dev  # Starts local server with tunnel

Add Extensions:

shopify app generate extension --type checkout_ui_extension

Deploy:

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:

shopify app generate extension
# Select type, configure
shopify app dev  # Test locally
shopify app deploy  # Publish

3. Theme Development

Setup:

shopify theme init
# Choose Dawn (reference theme) or start fresh

Local Development:

shopify theme dev
# Preview at localhost:9292
# Auto-syncs to development theme

Deployment:

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

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)

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

{% 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:

Scripts

shopify_init.py - Initialize Shopify projects interactively

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:

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.

Files (kilo-kit-mcp)
  • references
    • app-development.md 9.4 KB
      Loading…
    • extensions.md 10.3 KB
      Loading…
    • themes.md 10.1 KB
      Loading…
  • scripts
    • tests
      • test_shopify_init.py 13 KB
        Loading…
    • requirements.txt 452 B
      Loading…
    • shopify_init.py 12.3 KB
      Loading…
  • README.md 1.6 KB
    # Shopify API Research Documentation
    
    This directory contains comprehensive research and analysis of various APIs for integration purposes.
    
    ## Contents
    
    ### Shopify GraphQL Admin API Analysis
    **File:** `shopify-graphql-admin-api-analysis.md`  
    **Date:** 2025-10-25  
    **Status:** Complete  
    **Thoroughness:** Very Thorough
    
    A comprehensive analysis of Shopify's GraphQL Admin API covering:
    - API overview and capabilities
    - Key features and operations
    - Common query and mutation patterns
    - Best practices and optimization strategies
    - Authentication and security considerations
    - Rate limiting and performance optimization
    - Typical use cases and implementation patterns
    - Troubleshooting guide
    - Code examples in multiple languages
    - Resources and further learning
    
    **Key Sections:**
    1. Executive Summary
    2. API Overview
    3. Key Features
    4. Common Operations (Queries & Mutations)
    5. API Structure (Types, Connections, Errors)
    6. Best Practices
    7. Typical Use Cases
    8. API Versions and Deprecation
    9. Tools and SDKs
    10. Security Considerations
    11. Performance Optimization
    12. Common Patterns
    13. Troubleshooting
    14. Resources and Further Learning
    
    **Size:** 1,348 lines, ~26KB
    
    ---
    
    ## Usage
    
    These documents are intended for:
    - Development planning and architecture decisions
    - Team onboarding and training
    - Integration implementation reference
    - Best practices guidance
    - Troubleshooting support
    
    ---
    
    ## Maintenance
    
    - Documents should be reviewed quarterly
    - Update when API versions change
    - Add new findings from implementation experience
    - Keep code examples current with latest SDK versions
    
    ---
    
    **Last Updated:** 2025-10-25  
    **Maintained By:** Claude Code Engineering Team
    
  • SKILL.md 7.6 KB
    ---
    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.
    

Comments (0)

Sign in to join the conversation.

No comments yet.

Reviews (0)

No reviews yet.