Migrating metafields

Note

Metafields can be migrated using a third-party app. Metafields that are migrated using an app can appear in your Shopify admin without a definition. Follow the guide to find and edit these migrated metafields in your Shopify admin.

If you want to add validation rules to an existing set of metafields, then you can migrate your metafields to a definition. When you create a custom definition for existing sets of metafields, the validation rules that you specify prevent you or your apps from adding invalid values.

You migrate your metafields by creating a custom definition for a set of metafields with a particular namespace and key. You can migrate metafields to most content types, except for file, reference, and true or false. For more information about creating custom definitions, refer to the following:

• Creating custom definitions
• Metafield content types and values

You can only add definitions for sets of metafields that have a namespace and key with the correct format. If your namespace and key contains special characters, then you can't migrate that set of metafields to a definition.

Caution

Only create a definition for metafields with a namespace and key that you recognize. If you create a definition for metafields that an app needs for it to function correctly, then the definition might stop your apps from working as expected.

Create a definition for sets of metafields that don't yet have a definition

1. From your Shopify admin, go to Settings > Custom data.
2. Select the part of your store that you want to add a metafield definition for. For example, Products.
3. Click Metafields without a definition, and then click Add definition next to the namespace and key that you want to add a definition for.
4. Review the Sample metafield to determine the correct type and validation rules for the namespace and key. To display additional sample values, click View more.
5. Enter the following information for your metafield definition:
   1. In the Name field, enter a name for your definition.
   2. Optional: In the Description field, enter a description for your metafield.
6. Click Select content type, and then select the content type that best matches your metafield values from the list.
7. Configure the content type and validation information by doing the following:
   1. If the content type has additional configuration options, then select the correct option for your metafield. For example, type of measurement.
   2. In the Validation section, configure the Additional rules for your definition.
8. Click Save.
9. Review the validation results, and then click Save and continue.

If any metafield values don’t match your new definition, then you need to fix your metafield values. After you save your definition, you're automatically redirected to the bulk editor to review and fix any validation errors.

Edit metafields without a definition

Third-party metafields from an app can be migrated into your Shopify admin, but they are hidden. You can edit these metafields from the resource page that they appear on.

Steps:

1. From your Shopify admin, go to the resource that has the migrated metafields.
2. Scroll down to the Metafields section.
3. Click Show all.
4. Click the metafield line for the definition you want to edit, and then add the value.
5. Click Save.

If you don't see the Metafields section on your resource page, then go to Settings > Custom data and make sure at least one metafield definition exists. You can't see metafields in your resource without having at least one metafield definition created.

Next steps after adding metafield definitions

After you add definitions for your metafields, you can complete the following actions:

• Pin or unpin metafield definitions to determine the order in which your metafields are displayed.
• Add values to metafields for parts of your store.
• Connect your metafields to your theme to display them on your online store.