GitHub

ShopifyMetaobject

Type

import { ShopifyMetaobject } from '@daffodil/driver/shopify'

An instance of custom structured data defined by a metaobject definition. Metaobjects store reusable content that extends beyond standard Shopify resources, such as size charts, author profiles, or custom content sections.

Each metaobject contains fields that match the types and validation rules specified in its definition. Metafield references can point to metaobjects, connecting custom data with products, collections, and other resources. If the definition has the renderable capability, then the seo field provides SEO metadata. If it has the online_store capability, then the onlineStoreUrl field returns the public URL.

interface ShopifyMetaobject {
  __typename: "Metaobject"
  field: ShopifyMetaobjectField
  fields: ShopifyMetaobjectField[]
  handle: string
  id: string
  onlineStoreUrl: Maybe<Scalars['URL']['output']>
  seo: ShopifyMetaobjectSeo
  type: string
  updatedAt: Scalars['DateTime']['output']
}

Properties

__typename
"Metaobject"
field
ShopifyMetaobjectField

Accesses a field of the object by key.

fields
ShopifyMetaobjectField[]

All object fields with defined values. Omitted object keys can be assumed null, and no guarantees are made about field order.

handle
string

The unique handle of the metaobject. Useful as a custom ID.

id
string

A globally-unique ID.

onlineStoreUrl
Maybe<Scalars['URL']['output']>

The URL used for viewing the metaobject on the shop's Online Store. Returns null if the metaobject definition doesn't have the online_store capability.

seo
ShopifyMetaobjectSeo

The metaobject's SEO information. Returns null if the metaobject definition doesn't have the renderable capability.

type
string

The type of the metaobject.

updatedAt
Scalars['DateTime']['output']

The date and time when the metaobject was last updated.