Shopify for Craft CMS

Build a content-driven storefront by synchronizing Shopify products into Craft CMS.

[!IMPORTANT] Version 6.x of the Shopify plugin uses the new GraphQL Admin API to Upgrading section for more info about the impacts of this change.

Topics

• :package: Installation: Set up the plugin and get connected to Shopify.
• :card_file_box: Working with Products: Learn what kind of data is available and how to access it.
• :bookmark_tabs: Templating: Tips and tricks for using products in Twig.
• :leaves: Upgrading: Take advantage of new features and performance improvements.
• :telescope: Advanced Features: Go further with your integration.

Installation

Shopify requires Craft CMS 4.15.0+ or 5.0.0+.

To install the plugin, visit the Plugin Store from your Craft project, or follow these instructions.

1. Navigate to your Craft project in a new terminal:

2. Require the package with Composer:

3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Shopify, or run:

Create a Shopify App

The plugin works with Shopify’s Custom Apps system.

[!NOTE] If you are not the owner of the Shopify store, have the owner add you as a collaborator or staff member with the Develop Apps permission.

Follow Shopify’s directions for creating a private app (through the Get the API credentials for a custom app section), and take these actions when prompted:

1. App Name: Choose something that identifies the integration, like “Craft CMS.”

2. Admin API access scopes: The following scopes are required for the plugin to function correctly:

   • read_products
   • read_product_listings
   • read_inventory

   Additionally (at the bottom of this screen), the Webhook subscriptions → Event version should be 2024-10.

3. Admin API access token: Reveal and copy this value into your .env file, as SHOPIFY_ADMIN_ACCESS_TOKEN.
4. API key and secret key: Reveal and/or copy the API key and API secret key into your .env under SHOPIFY_API_KEY and SHOPIFY_API_SECRET_KEY, respectively.

Store Hostname

The last piece of info you’ll need on hand is your store’s hostname. This is usually what appears in the browser when using the Shopify admin—it’s also shown in the Settings screen of your store:

Save this value (without the leading http:// or https://) in your .env as SHOPIFY_HOSTNAME. At this point, you should have the following Shopify-specific values:

Connect Plugin

Now that you have credentials for your custom app, it’s time to add them to Craft.

1. Visit the Shopify → Settings screen in your project’s control panel.
2. Assign the four environment variables to the corresponding settings, using the special config syntax:
   • API Version: $SHOPIFY_API_VERSION
   • API Key: $SHOPIFY_API_KEY
   • API Secret Key: $SHOPIFY_API_SECRET_KEY
   • Access Token: $SHOPIFY_ACCESS_TOKEN
   • Host Name: $SHOPIFY_HOSTNAME
3. Click Save.

[!NOTE] These settings are stored in Project Config, and will be automatically applied in other environments. Webhooks will still need to be configured for each environment!

Set up Webhooks

Once your credentials have been added to Craft, a new Webhooks tab will appear in the Shopify section of the control panel.

Click Create on the Webhooks screen to add the required webhooks to Shopify. The plugin will use the credentials you just configured to perform this operation—so this also serves as an initial communication test.

[!WARNING] You will need to add webhooks for each environment you deploy the plugin to, because each webhook is tied to a specific URL.

[!NOTE] If you need to test live synchronization in development, we recommend using ngrok to create a tunnel to your local environment. DDEV makes this simple, with the ddev share command. Keep in mind that your site’s primary/base URL is used when registering webhooks, so you may need to update it to match the ngrok tunnel, then recreate your webhooks.

Upgrading

To guarantee that the plugin can access all the Shopify resources it needs, review Admin API access scopes in the requirements section before performing an upgrade.

After upgrading, check that the required webhooks are in place by visiting Shopify → Webhooks in the Craft control panel. The plugin will retrieve all the webhooks for your storefront, and display a Create button if any are missing for the current environment.

[!NOTE] You must create webhooks for each environment. Repeat this process in your live environment, after deploying.

The remainder of this section applies specifically to the 5.x → 6.x upgrade. Review the changelog for a complete list of added, removed, and deprecated APIs.

Deprecated Settings

The syncProductMetafields and syncVariantMetafields are no longer used, and should be removed from your configuration file. Meta fields are now automatically loaded alongside product and variant data.

Property Names

Accessors on our ProductVariant model documentation shows how to translate old property names (teal) to the new GraphQL schema (magenta).

Contextual Pricing

Shopify’s “presentment prices” are now referred to as “contextual pricing.” Variant arrays still have the default price and compareAtPrice fields (previously price and compare_at_price, respectively), but to fetch context-dependent prices, you must provide a list of two-letter country codes via the Contextual Pricing Countries setting. Product data must be sychronized after changing this setting.

Contextual prices are stored among other variant properties, with keys corresponding to each country code. For example: US pricing would be available as usContextualPricing; DE pricing would be available as deContextualPricing. Each contextual price has this structure:

You can display these prices using Craft’s built-in currency formatter:

Resource IDs

The GraphQL API no longer uses numeric IDs to look up objects; instead, it expects a new gid://-prefixed value. variants, and media.

Product Element

Products from your Shopify store are represented in Craft as product elements, and can be found by going to Shopify → Products in the control panel.

Synchronization

Once the plugin has been configured, you can perform an initial synchronization of all products via the control panel (via Utilities → Shopify Sync) or the command line:

This adds a bulk operation to the plugin’s internal queue. Once Shopify has gathered the data, it will issue a webhook to your project, and the plugin will download and process the payload.

Going forward, your products are automatically kept in sync via webhooks. You can view a history of synchronization operations by visiting the Shopify Sync utility.

Native Attributes

In addition to the standard element attributes like id, title, and status, each Shopify product element contains direct accessors for these canonical Shopify Product attributes:

All of these properties are available when working with a product element in your templates.

[!IMPORTANT]
See the Shopify documentation on the product resource for more information about what kinds of values to expect from these properties.

A complete copy of the Shopify API data used to populate a product element is available under its data property. Wherever possible, we have used Shopify’s native property names—but by virtue of fetching products via GraphQL, there may be differences between the structure of this object and the API documentation, especially as it relates to nested objects. Use the following methods to access related or nested data!

Methods

The product element has a few methods you might find useful in your templates.

Product::getVariants()

Returns an array of variants belonging to the product. Each variant is an associative array—not an element—but you can use the same dot notation to access their properties:

You can product query’s .withVariants() method.

Product::getDefaultVariant()

Shortcut for getting the first/default variant belonging to the product.

Product::getCheapestVariant()

Shortcut for getting the lowest-priced variant belonging to the product.

Note that this does not factor in contextual pricing.

Product::getShopifyUrl()

This has limited utility if you are displaying products on-site (rather than linking back to a Shopify storefront). To get the URL of a product within your Craft project, use product.url.

Product::getShopifyEditUrl()

For administrators, you can even link directly to the Shopify admin:

Custom Fields

Products synchronized from Shopify have a dedicated field layout, which means they support Craft’s full array of content tools.

The product field layout can be edited by going to Shopify → Settings → Products, and scrolling down to Field Layout.

Fields are accessible from any product element, by their handle:

Variants and other nested records do not support custom fields.

Routing

You can give synchronized products their own on-site URLs. To set up the URI format (and the template that will be loaded when a product URL is requested), go to Shopify → Settings → Products.

If you would prefer your customers to view individual products on Shopify, clear out the Product URI Format field on the settings page, and use product.shopifyUrl instead of product.url in your templates.

Product Status

A product’s status in Craft is a combination of its shopifyStatus attribute ('active', 'draft', or 'archived') and its enabled state. The former can only be changed from Shopify; the latter is set in the Craft control panel.

Note
Statuses in Craft are often a synthesis of multiple properties. For example, an entry with the Pending status just means it is enabled and has a postDate in the future.

In most cases, you’ll only want to display “Live” products, or those which are Active in Shopify and Enabled in Craft:

This is the default behavior when querying for products, but you can pass one of the custom Status options above to the .status() param to override it.

Querying Products

Products can be queried like any other element type in Craft.

A new query begins with the craft.shopifyProducts factory function:

The plugin automatically loads the relevant product when its Product fields also return product queries.

Query Parameters

The following element query parameters are supported, in addition to Craft’s standard set.

[!NOTE] Fields stored as JSON (like field layout.

shopifyId

Filter by legacy numeric Shopify product IDs.

shopifyGid

Filter by Shopify GIDs.

This is equivalent to .shopifyId(123456789), but may be simpler if you are combining data from client-side queries.

shopifyStatus

Directly query against the product’s status in Shopify.

Use the regular .status() param if you'd prefer to query against the synthesized product status values.

[!WARNING] Note that .shopifyStatus() does not override conditions applied by the .status() param (including the defaults). You may need to call .status(null) to unset them, or use .status('shopifyDraft'), directly.

handle

Query by the product’s handle, in Shopify.

[!WARNING] This is not a reliable means to fetch a specific product, as the value may change during a synchronization. If you want to store a permanent reference to a product, consider using the Shopify product field to relate it by element ID.

productType

Find products by their “type” in Shopify.

tags

Tags are stored as a JSON array, which may complicate direct comparisons. You may see better results using the .search() param.

options

Options are stored as a JSON array, which may complicate direct comparisons. You may see better results using the .search() param.

vendor

Filter by the vendor information from Shopify.

Eager-loading

Variants (ProductVariants), images (MediaImages), and meta fields (Metafields) attached to product elements are not elements themselves, and must be explicitly eager-loaded to avoid performance issues when displaying data in a loop:

[!TIP] The shorthand .withAll() is a future-proof means of eager-loading each additional type of nested record.

You can still access product.variants, product.images, and product.metafields without eager-loading—but it may result in an additional query for each kind of content. Once you’ve retrieved variants, for example, they are memoized on the product element instance for the duration of the request.

Templating

Product Data

Products behave just like any other element, in Twig. Once you’ve loaded a product via a custom field data.

[!NOTE] Some attributes are stored as JSON, which limits nested properties’s types. As a result, dates may be slightly more difficult to work with.

Variants and Pricing

Products don’t have a price, despite what the Shopify UI might imply—instead, every product has at least one Variant.

You can get an array of variant objects for a product by accessing product.variants or calling collect() Twig function.

Unlike products, variants in Craft…

• …are represented (mostly) as the API returns them;
• …the metafields property is accessible in addition to the API’s returned properties;
• …use Shopify’s convention of underscores in property names instead of exposing camel-cased equivalents;
• …are plain associative arrays;
• …have no methods of their own;

Once you have a reference to a variant, you can output its properties:

[!NOTE] The built-in currency Twig filter is a great way to format money values.

Using Options

Options are Shopify’s way of distinguishing variants on multiple axes.

If you want to let customers pick from options instead of directly select variants, you will need to resolve which variant a given combination points to.

Cart

Your customers can add products to their cart directly from your Craft site:

JS Buy SDK

On-site cart management and checkout are not currently supported in a native way.

However, Shopify provides the (deprecated) Javascript Buy SDK as a means of interacting with their Storefront API to create completely custom shopping experiences.

[!NOTE] Use of the Storefront API (directly, or via the Buy SDK or JS Buy Button) requires a different access key, and assumes that you have published your products into the Storefront app’s sales channel.

Your public Storefront API token can be stored with your other credentials in .env and output in your front-end with the {{ getenv('...') }} Twig helper—or just baked into a Javascript bundle. Keep your other secrets safe! This is the only one that can be disclosed.

The plugin makes no assumptions about how you use your product data in the front-end, but provides the tools necessary to connect it with the SDK. As an example, let’s look at how you might render a list of products in Twig, and hook up a custom client-side cart…

Shop Template: templates/shop.twig

Custom Script: assets/js/shop.js

This script must be registered after the Buy SDK.

Buy Button JS

The above example can be simplified with the Buy Button JS, which provides some ready-made UI components, like a fully-featured cart. The principles are the same:

1. Make products available via the appropriate sales channels in Shopify;
2. Output synchronized product data in your front-end;
3. Initialize, attach, or trigger SDK functionality in response to events, using Shopify-specific identifiers from step #2;

Storefront API Client

For fully custom front-end solutions, consider the Storefront API Javascript client, which is built and maintained with the new GraphQL API in mind.

See the usage examples for ideas. Many queries will require Shopify identifiers, which you can output as hidden attributes:

You would then consume these GIDs in Javascript, passing them to queries via the Shopify client. Here are the two GraphQL query fragments for creating and updating a cart:

…and the corresponding plumbing to connect those queries to the DOM elements and localStorage:

[!WARNING] This is just a slice of the required functionality for an on-site cart—the actual implementation depends largely on what features you want to offer customers, your front-end stack, and your appetite for dealing directly with the GraphQL client!

Checkout

While solutions exist for creating a customized shopping experience, checkout will always happen on Shopify’s platform. This is a policy matter, not a technical limitation of the plugin (or any other integration, for that matter)—Shopify’s checkout flow is fast, reliable, secure, and familiar to many shoppers.

If you want your customers’ entire journey to be kept on-site, we encourage you to try out our powerful ecommerce plugin, Commerce.

Helpers

In addition to product element methods, the plugin exposes its API to Twig via craft.shopify.

API Service

[!WARNING] Use of API calls in Twig blocks rendering and—depending on traffic—may cause timeouts and/or failures due to {% cache %} tag with a key and specific expiry time to avoid making a request every time a template is rendered:

You can make arbitrary GraphQL queries against the Shopify API with craft.shopify.api.query():

The Shopify GraphQL client is also available if you need to safely pass variables (like pagination offsets or search strings), or make mutations:

Store Service

A simple URL generator is available via craft.shopify.store. You may have noticed it in the cart example, above—but it is a little more versatile than that!

The same params argument can be passed to a product element’s getShopifyUrl() method:

Product Field

The plugin provides a Shopify Products field, which uses the familiar relational field UI to allow authors to select synchronized Product elements.

Relationships defined with the Shopify Products field use stable element IDs under the hood. When Shopify products are archived or deleted, the corresponding elements will also be updated in Craft, and naturally filtered out of your query results—including those explicitly attached via a Shopify Products field.

These fields return a supported query param—or immediately execute:

Going Further

Settings

The following settings can also be set via a shopify.php file in your config/ directory.

[!NOTE] Setting apiKey, apiSecretKey, apiVersion, accessToken, or hostName via shopify.php will override Project Config values set via the control panel during app setup. You can still reference environment values from the config file with craft\helpers\App::env().

Events

Learn about responding to events in the Craft extension documentation.

craft\shopify\services\Products::EVENT_BEFORE_SYNCHRONIZE_PRODUCT

Emitted just prior to a product element is saved with new Shopify data. The craft\shopify\events\ShopifyProductSyncEvent extends craft\events\CancelableEvent, so setting $event->isValid allows you to prevent the new data from being saved.

The event object has three properties:

• element: The product element being updated.
• source: The Shopify product object that was applied.

[!WARNING] Do not manually save changes made in this event handler. The plugin will take care of this for you!

Element API

Your synchronized products can be published into an Element API endpoint, just like any other element type. This allows you to set up a local JSON feed of products, decorated with any content you’ve added in Craft: