Skip to main content

How to Import and Export Shopify Metaobject Definitions

Export and import metaobject definitions to transfer custom content structures between Shopify stores.

Updated today

Goal: Export metaobject definitions from your Shopify store to a spreadsheet, and import them to create or update definitions on your store or transfer them to another store.

Video walkthrough: Watch the 2-minute video

Prerequisites:

  • You have Altera installed on your Shopify store

  • Metaobject definitions exist in your store (for exporting)

Step 1 - Export Metaobject Definitions

In your Shopify admin, go to Apps and open Altera. Click New Export and select Metaobject Definitions as the data type.

You can optionally filter by specific definition types or exclude Shopify-managed definitions. Click Start Export and wait for the export to complete.

Step 2 - Download and Review the Spreadsheet

Once the export finishes, click Download to save the spreadsheet file to your computer. Open the file in your spreadsheet application.

You will see columns including:

  • ID (the unique identifier for each metaobject definition)

  • Type (the technical identifier like celebrity or faq)

  • Name (the display name shown in Shopify admin)

  • Description (what the definition is used for)

  • Field: Key, Field: Type, Field: Required (the field definitions that make up the structure)

  • Validation columns (any validation rules applied to fields)

  • Access and Capability columns (API access and feature settings)

Step 3 - Make Changes (Optional)

If you want to update your metaobject definitions, edit the values in your spreadsheet. Common edits include:

  • Changing the Name to update display labels

  • Updating the Description to provide better guidance

  • Modifying Access: Storefront API to control public visibility

  • Adjusting Capability settings for translations or web page publishing

  • Adding or modifying Field definitions (new fields only - existing field keys and types cannot be changed)

Note that Type and Field: Key can only be set when creating new definitions and cannot be changed on existing ones.

Step 4 - Import the Spreadsheet

Return to Altera and click Upload file on the home page. Select your spreadsheet file.

The app will analyze the file and detect that it contains metaobject definitions. Review the preview showing which definitions will be created or updated. Since the Command column defaults to MERGE, existing definitions will be updated with your changes, and new definitions will be created if they don't exist.

Click Start import to apply the changes.

Outcome

Your metaobject definitions are now created or updated in your Shopify store. You can verify this by going to Settings > Custom data > Metaobjects in your Shopify admin, or by navigating to Content to see the definitions and any entries.

Transferring Definitions Between Stores

To transfer metaobject definitions from one store to another:

  1. Export the definitions from your source store using the steps above

  2. Install Altera on your destination store

  3. Import the same spreadsheet file to the destination store

The definitions will be created in the destination store with the same type, fields, and settings. You can then export and import the metaobject entries separately using the Metaobjects data type.

Sample File

Download the sample Metaobject Definition Import File to see the required columns and format.

Example

Type

Name

Field: Key

Field: Type

Field: Required

Access: Storefront API

attraction

Attraction

name

single_line_text_field

TRUE

PUBLIC_READ

attraction

Attraction

description

multi_line_text_field

FALSE

PUBLIC_READ

attraction

Attraction

image

file_reference

FALSE

PUBLIC_READ

Notes

Shopify-Managed Definitions:

Some metaobject definitions are managed by Shopify (type names starting with shopify--). Product category definitions like shopify--color-pattern or shopify--material can be enabled during import, but other Shopify-managed definitions cannot be imported.

Field Limitations:

  • Field keys and types can only be set when creating new definitions

  • Existing field keys cannot be renamed or have their types changed

  • New fields can be added to existing definitions

Did this answer your question?