Skip to main content

Metaobject Fields

Custom data structures that allow you to extend Shopify's data model with your own content types and relationships

Updated this week

Sample File

This sample file shows the basic columns that you need to set in order to import metaobjects to Shopify.

Download sample Metaobject Import File.

Before importing this sample data you will need to import the sample metaobject definitions first.

General

ID

Description

Example Value

Shopify's unique metaobject identifier

987654321

If present, the ID will be used to find an existing metaobject on the store. When importing, the ID will be used to see if the metaobject already exists. If there's no ID match the app will attempt to find an existing metaobject using the Handle.

Handle

Description

Example Value

URL-friendly identifier

product-specification

The handle is the URL-friendly identifier for the metaobject. The handle is used for finding an existing metaobject on the store if the ID is not present and for grouping multiple rows together.

Command

Description

Example Value

Action to perform: MERGE, DELETE, NEW

MERGE

  • MERGE: Update existing metaobject or create if not found

  • DELETE: Remove the metaobject from the store

  • NEW: Create a new metaobject (will fail if metaobject already exists)

Display Name

Description

Example Value

Human-readable name

Product Specification

The display name that appears in the Shopify admin and can be shown to customers if the metaobject is published.

Status

Description

Example Value

Current status: ACTIVE, DRAFT

ACTIVE

  • ACTIVE: Metaobject is published and can be referenced

  • DRAFT: Metaobject is in draft state and not publicly available

Updated At

Description

Example Value

Last modification timestamp

2023-06-15 14:30:00 -0400

The timestamp when the metaobject was last modified or updated.

Definition: Handle

Description

Example Value

Type of metaobject

product_specs

The handle of the metaobject definition that defines the structure and fields for this metaobject.

Definition: Name

Description

Example Value

Display name of the definition

Product Specifications

The display name of the metaobject definition that this metaobject is based on.

Top Row

Description

Example Value

Whether this is the first row for this metaobject

TRUE

  • TRUE: This is the primary row for the metaobject

  • FALSE: This is a secondary row for additional field data

Row

Description

Example Value

Row number for multi-row data

2

Used when a metaobject spans multiple rows (e.g., when including multiple field values).

Field

Description

Example Value

Metafield key

dimensions

The key of the metafield being set on this metaobject. The field must be defined in the metaobject definition.

Value

Description

Example Value

Metafield value

{"length": "10", "width": "5", "height": "2"}

The value being set for the specified field. The format and type must match what's defined in the metaobject definition.

Export Filters

You can use these filters to limit which metaobjects are exported:

  • handle: Filter by metaobject handle

  • type: Filter by definition type

  • updated_at: Filter by last update date

Did this answer your question?