Metafields can be added to Collections, Products and Product Variants. Metafields help you to customize the functionality and appearance of your Shopify store.
The mapping of Metafields will create a Metafield Definition. If the Name is not specified, the Metafield Definition name will be created with the key as the name and the name will not be updated and can be modified from the Shopify Admin page.
Mapping to field | Output Kind | Description |
|---|---|---|
Metafield|<namespace>|<key> Metafield|<namespace>|<key>|<type> Metafield|<namespace>|<key>|<type>|<name> | Field | Product metafield parameter. “namespace” and “key” combined value must be unique. “namespace” must have min 2 chars, max 20 chars and allowed characters are: A-Za-z0-9_.~-@#*$. “key” must have min 3 chars, max 30 chars and allowed characters are A-Za-z0-9_.~-@#*$ “type” parameter may have many values. Refer to Metafield Handling in order to see all supported values. Type is optional. If not defined the ‘string’ type will be used by default. “name” parameter is the name for the Metafield Definition |
Metafield|<namespace>|<key>|<type>|<name>@ShopifyUnit | Attribute | Get units from a string feature instead of using Perfion Feature Unit or json format. This only works for Dimension, |
Type | Description |
Bool | A true or false value or use numbers 0 and 1. Example: “true” |
Color | The hexadecimal code for a color including leading # char. Example: “#fff123” |
Date | A date in ISO 8601 format without a presumed time zone. Example: “2021-02-02” |
DateTime | A date and time in ISO 8601 format without a presumed time zone. Example: “2021-01-01T12:30:00” |
Dimension | A number value and a unit. Unit is by default the unit at the Perfion Feature, but can be set via an attribute @ShopifyUnit or the value can be a json string like { "unit": "cm", "value": 25.0 } Valid unit values: in, ft, yd, mm, cm, m. Example: 25.0 or { "unit": "cm", "value": 25.0 } |
Json | A JSON-formatted string. Example: “[{ "k": "v1" }, { "k": "v2" }]” |
MultiLineText
| A multi-line text field. Example: “Item list: Table Chair” |
Decimal | A number with decimal places in the range of +/-9999999999999.999999999. Example: “10.4” |
Integer Int | A whole number in the range of +/-9,007,199,254,740,991. Example: “10” |
Rating | A rating measured on a specified scale. This is a JSON-formatted string. Example: { "value": "3.5", "scale_min": "1.0", "scale_max": "5.0" } |
SingleLineText
| A single-line text field. Example: “Some text” |
PageRef | A reference to a page on the online store. This is a special Shopify URL. Example: “gid://shopify/OnlineStorePage/1” |
ProductRef | A reference to a product on the online store. This is a special Shopify URL. Example: “gid://shopify/Product/1” |
VariantRef | A reference to a product variant on the online store. This is a special Shopify URL. Example: “gid://shopify/ProductVariant/1” |
FileRef | A reference to a file on the online store. This is a special Shopify URL. Example: “gid://shopify/MediaImage/123” |
Url | A URL with one of the allowed schemes: https, http, mailto, sms, tel. Example: “Start and grow your e-commerce business - 3-Day Free Trial ” |
Bool | A true or false value. One can also use numbers 0 and 1. Example: “true” |
Weight | A value and a unit of weight. Valid unit values: oz, lb, g, kg. This is a JSON-formatted string. Example: “{ "unit": "kg", "value": 2.5 }” |
Volume | A value and a unit of volume. Valid unit values: ml, cl, l, m3 (cubic meters), us_fl_oz, us_pt, us_qt, us_gal, imp_fl_oz, imp_pt, imp_qt, imp_gal. This is a JSON-formatted string. Example: { "unit": "ml", "value": 20.0 } |