Metafields reference
Metafields let each product carry its own extra information, such as a badge, a list of features or a specification. This page lists every metafield Ignite looks for, and how to use your own.
Create a metafield
- In your Shopify admin, go to Settings > Metafields and metaobjects > Products and click Add definition.
- Enter a name. Shopify suggests a namespace and key from it, such as
custom.badge. For the metafields below, make sure the namespace and key match exactly. - Choose the type, and whether it holds one value or a list.
- Click Save, then fill it in on each product, near the bottom of the product page in your admin.
custom.badgeProduct metafields Ignite looks for
Create these with exactly the namespace and key shown, and Ignite uses them automatically once the matching setting is turned on.
| Namespace and key | Type | What it does | Guide |
|---|---|---|---|
custom.badge | Single line text | A custom badge on product cards, such as “Staff pick”. | Custom badges |
custom.badge_background_color | Color | That product’s badge background color. | Custom badges |
custom.badge_foreground_color | Color | That product’s badge text color. | Custom badges |
custom.badge_border_color | Color | That product’s badge border color. | Custom badges |
custom.highlights | Single line text, list | Highlight badges under the product name, one per value. | Highlight badges |
custom.highlights_label | Single line text | A label above that product’s highlight badges. | Highlight badges |
custom.highlights_color | Color | That product’s highlight badge color. | Highlight badges |
custom.options_badge_color | Color | That product’s option badge color. | Option badges |
custom.icons | File, list (images) | A row of icons on product cards and the product page. The alt text is the label. | Product icons |
custom.flash_sale_threshold | Single line text or integer | That product’s starting stock for the flash sale bar. | Flash sales |
custom.breadcrumbs | Collection, list | A fixed breadcrumb trail for that product. | Breadcrumbs |
Shopify’s standard metafields
Ignite also reads these, which Shopify or your apps fill in for you:
| Metafield | What it does | Guide |
|---|---|---|
| reviews.rating and reviews.rating_count | Star ratings on cards, the product page and in search results. Your reviews app fills these in. | Ratings and reviews |
| descriptors.subtitle | The Product subtitle, shown on cards and in the cart when turned on. | Product cards |
| Category metafields (shopify.*) | Color swatches on cards and in filters, and Compatibility finder badges. | Swatches |
Use your own metafields
You can name these anything you like, then point Ignite at them:
- Connect a setting: most text, image, link and color settings in the theme editor have a database icon. Click it and choose a metafield, so each product, collection or page shows its own value.
- Variant values in square brackets: the Table block and Notification message block accept a variant metafield, such as
[custom.storage_size], so the value changes with the chosen variant. - Compare specifications: the Product compare blocks take a metafield’s namespace and key.
- Hotspot positions: Image hotspots can read exact positions from metafields.
- Filters: the Quick filter and Compatibility finder use filters built from metafields in the Search & Discovery app.
Hide sections that have nothing to show
When a section gets its content from a metafield that some products leave empty, turn on its Hide this section when there’s no content to show setting. See Showing sections at the right time.
Common questions
What is a metafield in Shopify?
A custom field you add to products, collections, pages and more, to store information Shopify doesn’t have a field for, such as a material or a care guide.
Which metafields does Ignite use?
Ignite reads the custom.badge, custom.highlights, custom.icons, custom.flash_sale_threshold and custom.breadcrumbs product metafields, among others. The full list is on this page.
Can I show any metafield in Ignite?
Yes. Most text, image and link settings can be connected to a metafield with the database icon in the theme editor, so each product shows its own value.