Shopify Setup
Pick the minimum Shopify Admin API OAuth scopes before your agent reads or writes products, inventory, blogs, or theme files.
Overview
Shopify-setup is an agent skill for the Build phase that maps Shopify Admin API OAuth scopes to product, content, inventory, and file tasks so integrations request least privilege.
Install
npx skills add https://github.com/jezweb/claude-skills --skill shopify-setupWhat is this skill?
- Tables map read/write scopes for products, variants, collections, and inventory
- Content scopes cover pages, blogs, articles, and metaobjects
- File scopes for staged uploads and media management
- Optional scopes for themes, translations, navigation, and metaobject definitions
- Task matrix lists minimum scopes per workflow (catalog vs content vs files)
- Covers 3 required scope groups: product management, content management, and file management
- Documents 8+ optional Admin API scopes for themes, translations, and navigation
Adoption & trust: 875 installs on skills.sh; 841 GitHub stars; 2/3 security scanners passed (skills.sh audits).
What problem does it solve?
You are wiring Shopify automation but are unsure which Admin API scopes to enable without breaking catalog syncs or failing app review.
Who is it for?
Indie builders shipping Shopify-connected SaaS, headless storefronts, or agent tools that manage catalog and content via the Admin API.
Skip if: Teams that only need Storefront API or checkout extensions with no Admin API, or stores where OAuth scopes are already locked and documented elsewhere.
When should I use this skill?
You are creating or updating a Shopify custom app, agent tool, or sync and need to choose Admin API OAuth scopes before coding.
What do I get? / Deliverables
You get a task-aligned scope checklist for products, content, files, and optional theme or navigation work before implementing API clients.
- Least-privilege scope list per task
- Grouped scope checklist for OAuth app configuration
Recommended Skills
Journey fit
Store and Admin API wiring happens while you are building the product and its commerce integrations, not during idea research alone. Scopes are the prerequisite for any Shopify integration script, sync job, or agent tool that calls the Admin API.
How it compares
Use as a scope matrix before writing integration code—not instead of Shopify’s official OAuth and API reference documentation.
Common Questions / FAQ
Who is shopify-setup for?
Solo and indie developers who use AI coding agents to build Shopify Admin API integrations, sync jobs, or internal merchandising tools and need correct OAuth scopes on the first pass.
When should I use shopify-setup?
During Build integrations when you create a custom app, design an agent tool, or scope a sync for products, inventory, blogs, or file uploads—before implementing GraphQL or REST calls.
Is shopify-setup safe to install?
It is reference material only and does not execute against your store; review the Security Audits panel on this Prism page before installing skills from any third-party repo.
SKILL.md
READMESKILL.md - Shopify Setup
# Shopify Admin API Scopes Scopes needed for product and content management via the Admin API. ## Required Scopes ### Product Management | Scope | Enables | |-------|---------| | `read_products` | Query products, variants, images, collections | | `write_products` | Create/update/delete products and variants | | `read_product_listings` | Query products published to sales channels | | `read_inventory` | Query inventory levels and locations | | `write_inventory` | Adjust inventory quantities | ### Content Management | Scope | Enables | |-------|---------| | `read_content` | Query pages, blogs, articles, metaobjects | | `write_content` | Create/update/delete pages, blog posts, metaobjects | ### File Management | Scope | Enables | |-------|---------| | `read_files` | Query uploaded files (images, documents) | | `write_files` | Upload files via staged uploads | ## Optional Scopes Add these if needed for extended workflows: | Scope | Use Case | |-------|----------| | `read_themes` | Query theme files for template editing | | `write_themes` | Modify theme templates | | `read_translations` | Query store translations | | `write_translations` | Update translations | | `read_metaobject_definitions` | Query custom content types | | `write_metaobject_definitions` | Create custom content types | | `read_online_store_navigation` | Query navigation menus | | `write_online_store_navigation` | Update navigation menus | ## Scope Selection by Task | Task | Minimum Scopes | |------|---------------| | Add products | `read_products`, `write_products` | | Bulk product import | `read_products`, `write_products`, `write_files` | | Manage inventory | `read_inventory`, `write_inventory` | | Create pages | `read_content`, `write_content` | | Blog posts | `read_content`, `write_content` | | Upload images | `read_files`, `write_files` | | Update navigation | `read_online_store_navigation`, `write_online_store_navigation` | --- name: shopify-setup description: "Set up Shopify CLI auth and Admin API access for a store. Install CLI, authenticate, create custom app, store access token, verify. Use whenever the user wants to connect to a Shopify store, set up Shopify API access, install Shopify CLI, or troubleshoot Shopify auth / Admin API token issues." compatibility: claude-code-only --- # Shopify Setup Set up working Shopify CLI authentication and Admin API access for a store. Produces a verified API connection ready for product and content management. ## Workflow ### Step 1: Check Prerequisites Verify the Shopify CLI is installed: ```bash shopify version ``` If not installed: ```bash npm install -g @shopify/cli ``` ### Step 2: Authenticate with the Store ```bash shopify auth login --store mystore.myshopify.com ``` This opens a browser for OAuth. The user must be a store owner or staff member with appropriate permissions. After login, verify: ```bash shopify store info ``` ### Step 3: Create a Custom App for API Access Custom apps provide stable Admin API access tokens (unlike CLI session tokens which expire). **Check if an app already exists**: Ask the user if they have a custom app set up. If yes, skip to Step 4. **If no custom app exists**, guide the user through creation via browser: 1. Navigate to `https://{store}.myshopify.com/admin/settings/apps/development` 2. Click **Create an app** 3. Name it (e.g. "Claude Code Integration") 4. Click **Configure Admin API scopes** 5. Enable these scopes (see `references/api-scopes.md` for details): - `read_products`, `write_products` - `read_content`, `write_content` - `read_product_listings` - `read_inventory`, `write_inventory` - `read_files`, `write_files` 6. Click **Save** then **Install app** 7. Copy the **Admin API access token** (shown only once) Use browser automation (Chrome MCP or playwright-cli) if the user prefers assistance navigating the admin. ### Step 4: Store the Access Token Store the token securely. Never commit it to git. **For project use** — cr