How to Display Variant Metafields in Shopify

Table of Contents

1. Introduction
2. Understanding Variant Metafields
3. Setting Up Variant Metafields in Shopify
4. Displaying Variant Metafields on Product Pages
5. Conclusion
6. FAQs

Introduction

Imagine walking into a store and being able to see detailed information about each variant of a product effortlessly. In the world of e-commerce, particularly on Shopify, this is what variant metafields enable. Shopify's Online Store 2.0 provides enhanced capabilities for adding custom data to product variants, like color swatches, dimensions, and product care instructions. However, displaying these variant metafields on the product page can be tricky if you're not sure where to start.

Are you struggling to display variant-specific information for your products on Shopify? You're not alone. Many store owners face this issue, whether they're using the Dawn theme or another Shopify theme. By the end of this blog post, you'll have a detailed understanding of how to display variant metafields in your Shopify store, making your product pages as informative and customer-friendly as possible.

Built for Shopify

All Customisation  Solutions in One Place.

From Storefront to Operations - once you have it, you’ll love it.

Try for FREE

Understanding Variant Metafields

Variant metafields are custom fields that you can associate with different variants of a product. These metafields allow you to store additional data for each product variant, which can then be displayed on the product page. This data can include finishing details, dimensions, care instructions, and much more. The primary advantage is the customization it offers, ensuring that customers have all the necessary information to make informed purchasing decisions.

Key Benefits of Using Variant Metafields:

1. Enhanced Customization: Tailor each product variant's details specifically.
2. Improved Customer Experience: Provide more comprehensive information, aiding customer decision-making.
3. Better Organization: Keep your product information structured and easily accessible.

Setting Up Variant Metafields in Shopify

Before you can display variant metafields on your product page, you need to create and populate these metafields within Shopify. Here's a step-by-step guide to getting them set up.

Step 1: Create Variant Metafields

1. Login to Shopify Admin:

   • Navigate to Settings > Metafields.

2. Select Variant Metafields:

   • Choose "Variant" from the metafield type options.

3. Add Definition:

   • Click the "Add definition" button.
   • Name your metafield and set the Namespace and Key, which the system will use to identify the metafield.
   • Optionally, add a description for clarity.
   • Ensure you check the "Give access to Storefront API requests" option so the metafield values can be displayed on your storefront.
   • Choose the content type (e.g., text, number, file) based on what data you intend to store.

4. Save:

   • Hit the "Save" button to create the metafield definition.

Step 2: Add Values to Variant Metafields

Now that the variant metafields are defined, you need to add data to them:

1. Go to Product Variants:

   • From your Shopify admin, go to Products and select a product.
   • Scroll to the "Variants" section and click on a variant to edit it.

2. Enter Data:

   • Look for the metafield section within the variant's edit view.
   • Enter the relevant information for each metafield.

3. Save:

   • Save the changes to update the product variant with the metafield values.

Displaying Variant Metafields on Product Pages

To display metafield data on your product pages, you'll need to modify your theme’s code. Here's a general guide on how to do it using the popular Dawn theme.

Step 1: Access Theme Code

1. Navigate to Theme Customization:

   • Go to Online Store > Themes, next to your live theme click Actions > Edit code.

2. Locate Product Template:

   • Find product-template.liquid in the directory, typically under the "Sections" folder.

Step 2: Insert Code to Display Metafields

You'll need to add Liquid code to retrieve and display the metafield values:

1. Find Variant Loop:

   • Locate the section of the code that displays product variants. This is usually within a for loop iterating over the product's variants.

2. Add Metafield Display Logic:

   • Insert code to display the metafields. For example, to display metafields named "finish", "dimensions", and "product_care", you might use:

   {% for variant in product.variants %}
     <div class="variant-meta">
       <p>Finish: {{ variant.metafields.custom.finish }}</p>
       <p>Dimensions: {{ variant.metafields.custom.dimensions }}</p>
       <p>Product Care: {{ variant.metafields.custom.product_care }}</p>
     </div>
   {% endfor %}
   

   • Ensure that the namespace and key in the Liquid code match what you set up in Shopify.

3. Dynamic Metafield Updates:

   • If you want the displayed metafields to change dynamically based on the selected variant, you’ll need to add JavaScript to handle variant selection changes and update the displayed metafields accordingly.

Example JavaScript for Dynamic Updates

You can place the following JavaScript in your theme's main-product.liquid or a similar file:

document.addEventListener('DOMContentLoaded', function() {
  const variantSelect = document.querySelector('select[name="id"]');
  const metafieldDisplay = document.querySelector('.variant-meta');

  if (variantSelect && metafieldDisplay) {
    variantSelect.addEventListener('change', (event) => {
      const selectedVariant = event.target.selectedOptions[0];
      const finish = selectedVariant.getAttribute('data-finish');
      const dimensions = selectedVariant.getAttribute('data-dimensions');
      const productCare = selectedVariant.getAttribute('data-product-care');

      // Update meta-content (you may need to adjust nodes based on your HTML structure)
      metafieldDisplay.querySelector('[data-meta="finish"]').textContent = finish;
      metafieldDisplay.querySelector('[data-meta="dimensions"]').textContent = dimensions;
      metafieldDisplay.querySelector('[data-meta="product-care"]').textContent = productCare;
    });
  }
});

Update your product template with data attributes to make this work seamlessly.

{% for variant in product.variants %}
  <option 
    value="{{ variant.id }}" 
    data-finish="{{ variant.metafields.custom.finish }}"
    data-dimensions="{{ variant.metafields.custom.dimensions }}"
    data-product-care="{{ variant.metafields.custom.product_care }}">
    {{ variant.title }}
  </option>
{% endfor %}

Conclusion

Displaying variant metafields in Shopify can significantly enhance the shopping experience by providing detailed, variant-specific information. Although setting up and displaying these metafields requires some familiarity with Liquid and a bit of coding, the benefits in terms of customization and customer satisfaction make it worthwhile.

By following the steps outlined in this guide, you’ll be able to set up, populate, and display variant metafields on your Shopify store. This ensures your customers have all the information they need right at their fingertips, leading to more informed purchases and increased satisfaction.

FAQs

1. What are variant metafields used for in Shopify?

Variant metafields in Shopify are used to add unique, additional data to each product variant. This can include details like finish, dimensions, care instructions, and more.

2. Can I display variant metafields without editing the theme code?

Unfortunately, displaying variant metafields typically requires editing the theme’s Liquid code. However, you can use Shopify apps to manage metafields if you prefer not to code.

3. Where do I find the namespace and key for my metafields?

You can find the namespace and key for your metafields in Shopify under Settings > Metafields > Variants. The namespace and key are displayed below the metafield name.

4. Do changes to variant metafields automatically update on the product page?

If set up correctly with JavaScript, changes to variant metafields can dynamically update on the product page when a variant is selected. Otherwise, the page might need to be refreshed to see updates.

5. Can I use variant metafields for non-product data?

No, variant metafields are specifically designed for adding additional data to product variants. However, Shopify also allows metafields for other entities like customers and orders for adding custom information.

By leveraging variant metafields effectively, you can create a more personalized and informative shopping experience, setting your store apart in the crowded e-commerce space.