Metaobject

Metaobject capabilities for this Metaobject.

The app used to create the object.

The app used to create the object.

The staff member who created the metaobject.

The MetaobjectDefinition that models this object type.

The preferred display name field value of the metaobject.

The field for an object key, or null if the key has no field definition.

All ordered fields of the metaobject with their definitions and values.

The unique handle of the object, useful as a custom ID.

A globally-unique ID.

List of back references metafields that belong to the resource.

The recommended field to visually represent this metaobject. May be a file reference or color field.

The type of the metaobject.

When the object was last updated.

Retrieves a single Metaobject by its global ID. Metaobjects store custom structured data based on defined schemas. The returned metaobject includes its fields with values, display name, handle, and associated metadata like update timestamps and capabilities.

Retrieves a Metaobject by its handle and type. Handles are unique identifiers within a metaobject type.

Returns a paginated list of Metaobject entries for a specific type. Metaobjects are custom data structures that extend Shopify's data model with merchant or app-specific data types.

Filter results using the query parameter with a search syntax for metaobject fields. Use fields.{key}:{value} to filter by field values, supporting any field previously marked as filterable. The sortKey parameter accepts id, type, updated_at, or display_name to control result ordering.

Learn more about querying metaobjects by field value.

Creates a metaobject entry based on an existing MetaobjectDefinition. The type must match a definition that already exists in the shop.

Specify field values using key-value pairs that correspond to the field definitions. The mutation generates a unique handle automatically if you don't provide one. You can also configure capabilities like publishable status to control the metaobject's visibility across channels.

Learn more about managing metaobjects.

Updates a Metaobject with new field values, handle, or capabilities. Metaobjects are custom data structures that extend Shopify's data model.

You can modify field values mapped to the metaobject's MetaobjectDefinition, update the handle for a unique identifier, and adjust capabilities like publishing status. When updating the handle, you can optionally create a redirect from the old handle to maintain existing references.

Creates or updates a Metaobject based on its handle. If a metaobject with the specified handle exists, the mutation updates it with the provided field values. If no matching metaobject exists, the mutation creates a new one.

The handle serves as a unique identifier within a metaobject type. Field values map to the MetaobjectDefinition's field keys and overwrite existing values during updates.