When importing or exporting Shopify Metaobject Definitions, it is crucial to have a solid understanding of the data at hand. Any errors in your import file could lead to unexpected issues within your store and your metaobjects import and export.
This article provides a detailed overview of the data columns that can be imported or exported using the StoreRobo Import Export Suite.
>> Download sample CSVBasic columns
Basic columns in a Shopify metaobjects definitions export file typically contain the core metaobject definition-related information essential for managing metadata in your store.
| Column | Explanation | Allowed values / Examples |
|---|---|---|
| ID | This unique, system-generated identifier is assigned to each Metaobject definition when created. It helps Shopify track and manage different Metaobject definitions. When you import new Metaobject definitions, please leave this column empty. | Allowed values: Number Example: 232342332 |
| Handle | Uniquely identifies a specific Metaobject definition (the structure that outlines fields and types for a set of Metaobjects). Globally unique across all Metaobject definitions within your Shopify store, unlike Metaobject handles, which are unique only within their definition. If you don’t specify a handle when creating a new Metaobject definition, Shopify will generate one from the definition’s Display Name. | Allowed values: Text Example: product-specification |
| Name | Designed to be easily understood and typically describes the purpose or content of the Metaobject definition (e.g., “Product Specifications,” “Event Details,” “Beekeeper Information”). Once a Metaobject definition is created and assigned a name, this name becomes fixed and cannot be altered. The name refers to the definition in exports and when managing Metaobjects. | Allowed values: Text Example: Event Details |
| Description | It briefly explains what the Metaobject definition represents or how it will be used. This can be helpful for store administrators or developers when managing Metaobjects. | Allowed values: Text Example: Event description |
| Metaobjects Count | It indicates how many Metaobject entries exist for a particular Metaobject definition. This count can help store administrators track how extensively a specific Metaobject definition is used. It’s beneficial when you need to monitor or manage large numbers of entries for a particular definition. The Metaobjects Count changes as new entries are added or existing ones are deleted under that definition. | Allowed values: Number Example: 50 |
Fields
Fields in Metaobject Definitions are the individual attributes or data points that define the structure of each Metaobject entry. These fields determine what kind of information can be stored in a Metaobject entry and are specified when creating or managing a Metaobject definition.
| Column | Explanation | Allowed values / Examples |
|---|---|---|
| Field: Name | This is the name of the specific field within a Metaobject definition. It’s a descriptive label for what the field represents. | Allowed values: Text Example: Product Name |
| Field: Description | Provides additional context or information about the field. It helps explain what kind of data should be entered in this field. | Allowed values: Text Example: Product Description |
| Field: Key | The key is a unique identifier for the field, often used in code or APIs. It’s like the handle for a specific field within the Metaobject definition. | Allowed values: Text Example: product_name |
| Field: Required | This field indicates whether the data entry for this field is mandatory (true) or optional (false). | Allowed values:TrueFalseExample: True |
| Field: Type | Specifies the type of data that is allowed in this field. Each field can store a specific value, such as text, number, image, date, etc. | Allowed values: Text Example: Number |
| Field: Validation Name | Defines the type of validation that will be applied to ensure the entered value meets specific criteria. This helps ensure data consistency and accuracy. For a “Number” field, the validation name might be min_value or max_value.For a “Text” field, it might be max_length. | Allowed values: Text Example: min_value |
| Field: Validation Value | The value that enforces the validation rules set by the Validation Name. It defines the limits or conditions for the field’s input. If Validation Name is min_value, the Validation Value could be 1, meaning the field must have a value of at least 1. | Allowed values: Text Example: min_value |
Access
This section refers to who or what can view or use the Metaobject data.
| Column | Explanation | Allowed values / Examples |
|---|---|---|
| Access: Admin | The value in this field determines who can read or write to metaobjects within the Shopify admin.PRIVATE: Only the app that owns a metaobject of this type can read and write to it.MERCHANT_READ: Apps that act on behalf of the app user (such as the admin) can read metaobjects of this type. Only the owning app can write to metaobjects of this type.MERCHANT_READ_WRITE: Both the owning app and apps that act on behalf of the app user (such as the admin) can read or write to metaobjects of this type. No other applications can read or write metaobjects.PUBLIC_READ: All apps with the metaobject access scope can read metaobjects of this type. Only the owning app can write to metaobjects of this type.PUBLIC_READ_WRITE : All apps with the metaobject access scope can read and write metaobjects. | Allowed values:PRIVATEMERCHANT_READMERCHANT_READ_WRITEPUBLIC_READPUBLIC_READ_WRITEExample: PUBLIC_READ |
| Access: StoreFront | The value in this field controls how metaobjects are accessed via the storefront.NONE: Metaobjects of this type aren’t accessible in any Storefront API requests or Liquid.PUBLIC_READ: Metaobjects of this type are accessible in the Storefront GraphQL API by any app with the unauthenticated_metaobjects access scope. They are also accessible in the online store Liquid Templates. | Allowed values:NONEPUBLIC_READExample: NONE |
Options
| Column | Explanation | Allowed values / Examples |
|---|---|---|
| Option: Active-draft Status | Determines whether a Metaobject entry is in an “Active” or “Draft” state. TRUE: The entry is live and can be used or displayed in the storefront. FALSE: The entry is not yet published and won’t be visible in the storefront until it is set to Active. | Allowed values:TrueFalseExample: True |
| Option: Translation | Specifies whether the Metaobject supports translations. This allows the content to be available in multiple languages. | Allowed values:TrueFalseExample: True |
| Option: Publish as web pages | Allows Metaobject entries to be published as standalone web pages on the storefront. If true, the Metaobject entry will be published as a standalone web page on the storefront. This means it will be accessible via a unique URL and can be viewed by customers as part of the public-facing store. | Allowed values:TrueFalseExample: True |
| Option: Online Store enabled | Determine whether the MetaObject entry is enabled or visible in the online store. | Allowed values:TrueFalseExample: True |
| Option: URL Handle | The URL-friendly identifier for the Metaobject entry when published as a web page. It forms part of the URL where the entry can be accessed. | Allowed values: Text Example: item_one |
| Option: URL Redirects | When this option is true, you can set up redirects from old to new URLs. This ensures that any traffic or links to the old URLs are automatically redirected to the new URLs, preserving user experience and SEO rankings. | Allowed values:TrueFalseExample: True |
| Option: Page Title | The title of the web page where the Metaobject entry is published. This is displayed in the browser tab and is often used by search engines. | Allowed values: Text Example: Meta Title |
| Option: Meta description | A summary of the page content, used by search engines to describe the page in search results. | Allowed values: Text Example: Meta Description |
