How to show Shopify metafields in Framer CMS

By Jake Marsh · Updated

To show Shopify metafields in Framer CMS, first turn on Storefront access for each metafield in Shopify under Settings > Custom data. Then open Shelfferry in Framer, go to the Fields tab, type the metafield's namespace and key (like custom.material) under Metafields and click Add. Shelfferry picks the Framer field type from the metafield's type in your store. Run the dry run and sync, and the metafield is a CMS field you can put on product pages.

Before you start

  • A synced collection of Products, Variants or Collections. Metafields are added per collection, so variant metafields go on the Variants collection.
  • The metafield's namespace and key. In Shopify, they're shown on the metafield definition, for example custom.care_instructions.
  • Storefront access turned on for that definition. Without it, the Storefront API doesn't return the value, and the field arrives empty.

Steps

  1. In Shopify admin, go to Settings > Custom data and open Products (or Variants, or Collections).
  2. Open the metafield definition and turn on its Storefront access. Save.
  3. In Framer, open Shelfferry and pick the synced collection.
  4. Go to the Fields tab and find the Metafields section.
  5. Type the namespace and key, such as custom.material, and click Add. Add up to 20 per collection.
  6. Check the field's name and type in the list. A key like custom.care_instructions becomes a field named "Care instructions", which you can rename. The hint shows the Shopify type Shelfferry saw, or "no value seen yet".
  7. Click Dry run: see what will change. Review lists metafields that had no values in any product, which usually means Storefront access is still off.
  8. Sync, then bind the new field on your CMS page.

How types come across

Shopify metafield typeFramer CMS field
Integer, decimal, ratingNumber
True or falseToggle
URLLink
Date, date and timeDate
ColorColor
Rich textFormatted text
File (image)Image
Single line text, multi-line text, and anything elseText

List metafields, such as a list of colors, arrive as one text field with the values separated by commas.

Ideas for product pages

  • A Material or Care text field under the description.
  • A Color metafield driving a swatch's fill.
  • A Rating number shown as stars.
  • A Size guide image on each product.
  • A Launch date to sort a collection list.

What it costs

Adding metafields and the dry run are free. Syncing is covered by the trial (5 syncs of up to 25 products over 7 days, no card), then $59 a month, $499 a year or $699 once per seat. Details on the Shelfferry page.

Shelfferry

Sync a Shopify store's products, variants, collections, metafields and market prices into Framer CMS, and sell with buy buttons, a cart and Shopify checkout that keep working without a subscription $59 a month or $499 a year per seat, or $699 once.


Questions

Why is my metafield empty in Framer?

Most often Storefront access is off for that metafield's definition in Shopify. Turn it on, then run the dry run again.

How many metafields can I add?

Up to 20 per synced collection. Products, Variants and Collections each have their own list.

Do metafield changes sync on their own?

They come across the next time someone presses Sync on the collection in Framer's CMS.

Can I filter a Framer collection list by a metafield?

Once it's synced, it's a CMS field like any other, so Framer's collection list filters can use it.


More Shelfferry guides


More Framer guides