Shopify Setup

What Is Shopify Setup?

Shopify Setup is a specialized Claude Code skill designed to streamline and automate the process of configuring Shopify CLI authentication and establishing Admin API access for a Shopify store. This skill is tailored for developers and technical users who need to efficiently connect to Shopify stores, set up API integrations, or resolve issues related to Shopify CLI authentication or Admin API tokens. By following a consistent workflow, Shopify Setup ensures that you have a reliable and verified connection to your Shopify store, paving the way for robust app development, product management, or other automation tasks.

Why Use Shopify Setup?

Setting up a secure and functional API connection to a Shopify store can be a multi-step process, often prone to errors or overlooked prerequisites. Manual configuration increases the risk of missteps, leading to authentication failures, expired tokens, or insufficient API permissions. Shopify Setup addresses these challenges by providing a guided, repeatable workflow that reduces setup time, improves reliability, and minimizes the chances of misconfiguration.

Using Shopify Setup is especially valuable in the following scenarios:

• First-time API integration: When connecting a new app or automation to a Shopify store.
• Onboarding new developers: Standardizes the process, reducing onboarding friction.
• Troubleshooting authentication issues: Offers a stepwise approach to identify and resolve common problems with Shopify CLI or Admin API tokens.
• Managing multiple stores: Simplifies context switching and access management for agencies or freelancers.

How to Get Started

The Shopify Setup skill involves a clear workflow designed to ensure a secure and functional connection to the Shopify Admin API. Below is a step-by-step guide, including practical code examples.

Step 1:

Check Prerequisites

Verify that the Shopify CLI is installed. Open your terminal and run:

shopify version

If the CLI is not installed, add it via npm:

npm install -g @shopify/cli

Step 2:

Authenticate with the Store

Authenticate your CLI session with your Shopify store:

shopify auth login --store mystore.myshopify.com

This command will prompt you to log in through your web browser. Ensure you use a store owner or staff account with sufficient permissions.

After logging in, verify your connection:

shopify store info

This should display your store details, confirming successful authentication.

Step 3:

Create a Custom App for API Access

Custom apps provide persistent Admin API tokens, essential for automated scripts and integrations. Begin by checking if a custom app already exists for your integration. If not, guide the user to create one:

1. Navigate to:
   https://{store}.myshopify.com/admin/settings/apps/development
2. Click Create an app.
3. Enter a name (e.g., "Claude Code Integration").
4. Click Configure Admin API scopes and select the necessary permissions for your use case.
5. Save your configuration.

Step 4:

Retrieve and Store the Admin API Access Token

Once the custom app is set up, generate an Admin API access token. This token is required for authenticated API requests. Store it securely (for example, in an environment variable or secret manager):

export SHOPIFY_ADMIN_API_TOKEN='your-access-token'

Step 5:

Verify API Access

Test your API access with a simple authenticated request. For example, using curl:

curl -X GET "https://{store}.myshopify.com/admin/api/2023-10/shop.json" \
-H "X-Shopify-Access-Token: $SHOPIFY_ADMIN_API_TOKEN"

A successful response confirms your setup is complete.

Key Features

• Automated CLI Installation Check: Detects and guides installation of the Shopify CLI.
• Stepwise Authentication: Ensures users are authenticated with the correct store and permissions.
• Custom App Creation Guidance: Provides clear instructions for establishing a stable Admin API integration.
• Token Management: Emphasizes secure storage and verification of API tokens.
• Troubleshooting Support: Aids in diagnosing and resolving common authentication or connection issues with both CLI and API tokens.
• Repeatable Workflow: Standardizes setup across teams and environments, increasing reliability.

Best Practices

• Use Custom Apps for API Integrations: Always create and use a custom app for API access instead of relying on session tokens, which are short-lived and unsuitable for automation.
• Limit API Scopes: Grant only the minimum required permissions to the custom app. This principle of least privilege enhances security.
• Secure Token Storage: Store access tokens in environment variables, secret managers, or other secure locations. Avoid hardcoding them into scripts or sharing them via insecure channels.
• Regularly Rotate Tokens: Periodically regenerate and update your API access tokens to reduce the risk of unauthorized access.
• Document the Setup: Maintain internal documentation for your team describing the setup process, including which API scopes are required and where tokens are stored.

Important Notes

• Account Permissions: Only store owners or staff members with sufficient permissions can complete all steps, including app creation and scope assignment.
• Token Visibility: Shopify displays Admin API access tokens only once upon creation. Store them securely at that time; lost tokens cannot be retrieved and require regeneration.
• API Versioning: Specify the correct API version in all requests to ensure compatibility and avoid breaking changes.
• Compliance: Be mindful of Shopify’s API rate limits and data privacy requirements. Improper handling of access tokens or data can lead to account suspension or compliance violations.
• Skill Compatibility: The Shopify Setup skill is compatible only with Claude Code, and is intended for technical users familiar with command-line workflows and API integrations.