Shopify API Getting Started: Quickstart Guide (2026)

Getting started overview

To begin developing with the Shopify API, the initial steps involve setting up a development environment, acquiring necessary credentials, and executing a basic API call to confirm connectivity. Shopify provides two primary APIs: the Admin API for managing store data like products, orders, and customers, and the Storefront API for custom client-side experiences. Both support REST and GraphQL interfaces, offering flexibility for various development patterns.

The process typically starts with creating a Shopify Partner account, which is distinct from a merchant account and designed for developers building apps and themes. Within the Partner dashboard, developers can create development stores—fully functional Shopify stores that are free to use for testing and development purposes. These stores serve as the sandbox for integrating with the Shopify API without impacting live merchant data. API credentials, including an API key and API secret, are generated within the context of an app created in the Partner dashboard and linked to a development store. Authentication for the Admin API primarily uses OAuth 2.0, requiring an authorization flow to obtain an access token.

Quick Reference Steps

Create an account and get keys

To begin, create a Shopify Partner account. This account type is specifically designed for developers, agencies, and partners who build apps, themes, or custom solutions for Shopify merchants. It differs from a standard merchant account in that it provides tools for app development, theme creation, and managing multiple client stores.

1. Sign Up for a Shopify Partner Account: Navigate to the Shopify Partners website and complete the registration process. This account will be your central hub for all development activities.
2. Create a Development Store: Once logged into your Partner dashboard, go to the 'Stores' section and select 'Add store' > 'Create development store'. A development store is a free, fully functional Shopify store that you can use for testing your apps and integrations without incurring costs or affecting a live merchant's data. You will need the store's .myshopify.com domain for API requests.
3. Create a New App: In your Partner dashboard, go to the 'Apps' section and click 'Create app'. You'll be prompted to choose between creating a 'Custom app' for a single store or a 'Public app' for the Shopify App Store. For initial testing and integration with a development store, a Custom app is often sufficient and simpler. Provide an app name.
4. Configure App Settings and Permissions: After creating your app, you'll be directed to its settings. Here, you define the API scopes your app requires. Scopes determine what kind of data your app can access and modify (e.g., read_products, write_orders). Select the necessary permissions for your intended functionality. For example, to retrieve product lists, you would need at least read_products.
5. Install the App on Your Development Store: After configuring permissions, you'll install the app on your development store. This process initiates the OAuth flow. Shopify will redirect you through an authorization URL, and upon successful authorization, an access token will be generated. This access token is critical for authenticating your API requests to the Admin API. Keep this token secure, as it grants access to your store's data. The API Key and API Secret are typically displayed in your app's settings within the Partner dashboard.

Your first request

Once you have your development store, app credentials (API Key, API Secret), and an access token, you can make your first API call. This example demonstrates fetching a list of products using the Shopify Admin REST API.

Prerequisites:

• Your development store URL (e.g., your-store-name.myshopify.com)
• Your Admin API access token
• A tool for making HTTP requests (e.g., cURL, Postman, or a programming language's HTTP client)

Example: Fetching Products (REST API)

This cURL command retrieves the first 50 products from your development store. Replace {your-store-name} with your actual development store's subdomain and {your-admin-api-access-token} with the token you obtained.

curl -X GET \
  "https://{your-store-name}.myshopify.com/admin/api/2024-04/products.json?limit=50" \
  -H "X-Shopify-Access-Token: {your-admin-api-access-token}" \
  -H "Content-Type: application/json"

Explanation:

• -X GET: Specifies the HTTP GET method.
• "https://{your-store-name}.myshopify.com/admin/api/2024-04/products.json?limit=50": The endpoint for fetching products. The 2024-04 denotes the API version, which Shopify updates quarterly. It's recommended to specify a stable version. The limit=50 parameter requests up to 50 products.
• -H "X-Shopify-Access-Token: {your-admin-api-access-token}": This header carries your Admin API access token, authenticating your request.
• -H "Content-Type: application/json": Indicates that the expected response format is JSON.

If successful, the API will return a JSON object containing a list of products available in your store. If there are no products, it will return an empty array within the products key.

For GraphQL, the approach involves sending a POST request with a GraphQL query in the request body. Shopify provides a detailed GraphQL product query example in their documentation.

Common next steps

After successfully making your first API call, consider these common next steps to deepen your integration and develop more robust applications:

• Explore API Documentation: Familiarize yourself with the extensive Shopify Admin REST API documentation and the Admin GraphQL API documentation. These resources detail all available endpoints, required parameters, and response structures for various resources like orders, customers, and inventory.
• Implement OAuth Properly: For production apps, properly implementing the OAuth 2.0 authorization flow is crucial. This ensures secure authentication and allows merchants to grant and revoke permissions for your app. Shopify's OAuth documentation provides a comprehensive guide. Understanding the OAuth 2.0 authorization framework is key for building secure applications that interact with protected resources, as detailed by oauth.net's specification.
• Use Webhooks for Real-time Updates: Instead of polling the API, use webhooks to receive notifications about events in a store (e.g., new order, product update). This reduces API call overhead and enables real-time reactions to store activities.
• Develop with an SDK: Shopify offers official and community-supported SDKs for various programming languages (e.g., Ruby, Node.js, Python). Using an SDK can streamline development by handling authentication, request signing, and response parsing.
• Error Handling: Implement robust error handling in your application to gracefully manage API rate limits, invalid requests, and other potential issues. Review Shopify's API response codes for guidance.
• Address Rate Limits: Be aware of Shopify's API rate limits to avoid overwhelming the API and getting throttled. Implement strategies like exponential backoff and request queuing.
• Build a Headless Storefront: If your goal is to create a custom frontend experience, explore the Shopify Storefront API and the Hydrogen framework.

Troubleshooting the first call

Encountering issues during your first API call is common. Here are some troubleshooting tips:

• Check Access Token Validity: Ensure your Admin API access token is correct and has not expired or been revoked. If you regenerated the token, update it in your request. Tokens are usually long-lived for custom apps but can be invalidated by reinstallation or explicit revocation.
• Verify API Scopes: Confirm that your app has been granted the necessary API scopes (permissions) for the endpoint you are trying to access. For example, trying to create a product without write_products scope will result in an authorization error. You can review and adjust scopes in your app settings within the Shopify Partner dashboard.
• Correct Store URL: Double-check that the .myshopify.com URL in your request matches your development store's URL exactly.
• API Version: Ensure you are using a valid and supported API version in your endpoint URL (e.g., /admin/api/2024-04/). Using an outdated or future version might lead to errors or unexpected behavior.
• Content-Type Header: For POST or PUT requests, ensure the Content-Type: application/json header is correctly set and that your request body is valid JSON. Even for GET requests, it's good practice to include it if you expect JSON responses.
• Rate Limiting: If you receive 429 Too Many Requests errors, you have hit the API rate limit. Implement a delay and retry mechanism, such as exponential backoff, before sending further requests. Monitor the X-Shopify-Shop-Api-Call-Limit header in responses to track your current usage against the limit.
• Detailed Error Messages: Pay close attention to the error messages returned by the API. Shopify's error responses often provide specific details about what went wrong, which can guide your debugging efforts. For example, a 404 Not Found might indicate an incorrect endpoint or resource ID, while a 401 Unauthorized points to authentication or scope issues.