Definition Management

Browse, duplicate, export, import, and manage your metaobject definitions.

What is a Definition?

A definition (also called a metaobject type or schema) is a template for a specific kind of structured content in your store. Think of it as a blueprint that tells Shopify what fields and information types a metaobject should have.

For example, you might have a definition for "Brand Partners" that includes fields like partner name, logo, description, and website URL. Or you could have a "Product Review" definition with fields for reviewer name, rating, and review text.

Once a definition exists, you can create many entries (individual pieces of data) based on that template. The Definitions Manager helps you work with those entries in bulk.

Browsing Your Definitions

When you open Structa, the Definitions Manager appears on the homepage. You'll see a table listing all the metaobject definitions in your store. Each row shows:

• Definition Name — The human-readable name of the definition (e.g., "Brand Partners")
• Type — The internal identifier used by Shopify (e.g., brand_partners)
• Fields — The number of data fields in this definition
• Description — An optional note explaining what this definition is for

Searching Definitions

If you have many definitions, use the search box at the top of the table to quickly find what you need. You can search by definition name, type, or description text. The table filters in real time as you type.

Editing Definition Entries

To start editing the entries (data) for a definition, click on the definition row. This takes you to the bulk edit page, where you can view and edit all entries for that definition at once.

Duplicating a Definition

Use the duplicate feature to quickly create a new definition based on an existing one.

1. Find the definition you want to copy in the table.
2. Click the three-dot menu button on the right side of the row (under "Actions").
3. Select Duplicate.

The Duplication Dialog

A dialog opens asking you to configure the new definition:

• Definition Name — Pre-filled with "Copy of [original name]". You can change this to anything you like (up to 255 characters).
• Definition Type — The internal identifier. It must start with a letter, contain only lowercase letters, numbers, hyphens, and underscores, and be unique. A unique type is automatically suggested (e.g., brand_partners_2).
• Description — Copied from the original but you can edit or remove it.

What Gets Copied vs. What Doesn't

Copied:

• All field definitions (names, types, descriptions)
• Field validations (e.g., minimum/maximum values, required settings)
• Storefront access settings
• All field configuration details

Not copied:

• Any entries or data (the copy starts empty)
• The original definition ID
• Creation timestamps

Exporting a Definition

Export lets you download a definition as a JSON file. This is useful for sharing definitions with team members, backing them up, or preparing them to import elsewhere.

1. Find the definition in the table.
2. Click the three-dot menu button on the right side of the row.
3. Select Export.

The definition is immediately downloaded as a JSON file named {type}_definition.json (for example, brand_partners_definition.json). The file contains the definition name, type, description, all field definitions and configurations, field validations, and storefront access settings. It does not include any entries or data — only the schema.

Importing a Definition

Import lets you upload a JSON file (usually from a previous export) to create a new definition. This is useful for recreating definitions, sharing schemas across stores, or restoring backups.

1. Click the Import button in the top right corner of the Definitions Manager.
2. A dialog opens with a drop zone. You can either drag and drop a JSON file onto it, or click the drop zone to browse for a file on your computer.

Reviewing Before You Import

Once you upload a valid JSON file, the dialog shows:

• Definition Name — From the JSON file. You can edit this before creating.
• Definition Type — From the JSON file. You can edit this, but it must be unique.
• Description — From the JSON file. You can edit or remove this.
• Field Preview — Click "Show X fields to import" to expand a preview showing all the fields that will be created.

Conflict Detection

If the definition type you're trying to import already exists in your store, the import dialog catches it and shows an error. You'll need to either change the definition type to something unique, or use the suggested alternative type provided by the dialog.

Once all fields are valid and there are no conflicts, the "Import definition" button becomes available.

After a successful import, a confirmation message appears. Click View in the message to jump straight to the bulk edit page for your newly imported definition.

Creating a New Definition

To create a brand new definition:

1. Click the Create Definition button at the top of the Definitions Manager.
2. This opens Shopify's native definition editor in the admin.
3. Configure your fields, validations, and settings there.
4. When you return to the app, the definitions list automatically refreshes to include your new definition.

Deleting a Definition

1. Find the definition in the table.
2. Click the three-dot menu button on the right side of the row.
3. Select Delete.
4. A confirmation dialog appears with a red warning banner explaining that this action is permanent and cannot be undone, and that all entries within the definition will also be deleted.
5. To confirm, you must type the definition type exactly as shown (e.g., brand_partners).
6. Click the Delete button to permanently remove the definition.

This safety step prevents accidental deletions — you cannot delete a definition without typing its exact type.

Actions Menu

Each definition row in the table has a three-dot menu button (under "Actions") with the following options:

• Duplicate — Create a copy of this definition (with optional entry duplication)
• Export — Download the definition as JSON
• Delete — Permanently remove this definition and all its entries

There is also a Manage Definitions link that opens Shopify's custom data settings page where you can edit field configurations, access rules, and other advanced settings.

Tips

• Start small — If you're new to metaobjects, create a simple definition first to get familiar.
• Use descriptive names — The description field helps you and your team remember what each definition is for.
• Export before major changes — Export a definition as a backup before making significant modifications.
• Search is your friend — With many definitions, search is faster than scrolling.
• Test with duplicates — Duplicate a definition to test changes without affecting your live data.