Metaobject - admin-graphql - OBJECT

Version: 2024-10

Description:

Provides an object instance represented by a MetaobjectDefinition.

Access Scopes

`read_metaobjects` access scope.

Fields

  • capabilities: MetaobjectCapabilityData! - Metaobject capabilities for this Metaobject.
  • createdBy: App! - The app used to create the object.
  • createdByApp: App! - The app used to create the object.
  • createdByStaff: StaffMember - The staff member who created the metaobject.
  • definition: MetaobjectDefinition! - The MetaobjectDefinition that models this object type.
  • displayName: String! - The preferred display name field value of the metaobject.
  • field: MetaobjectField - The field for an object key, or null if the key has no field definition.
  • fields: MetaobjectField! - All ordered fields of the metaobject with their definitions and values.
  • handle: String! - The unique handle of the object, useful as a custom ID.
  • id: ID! - A globally-unique ID.
  • staffMember: StaffMember - The staff member who created the metaobject.
  • thumbnailField: MetaobjectField - The recommended field to visually represent this metaobject. May be a file reference or color field.
  • type: String! - The type of the metaobject.
  • updatedAt: DateTime! - When the object was last updated.

Connections

  • referencedBy: MetafieldRelationConnection!

Related queries

  • metaobject Retrieves a metaobject by ID.
  • metaobjectByHandle Retrieves a metaobject by handle.
  • metaobjects All metaobjects for the shop.

Related mutations

  • metaobjectCreate Creates a new metaobject.
  • metaobjectUpdate Updates an existing metaobject.
  • metaobjectUpsert Retrieves a metaobject by handle, then updates it with the provided input values. If no matching metaobject is found, a new metaobject is created with the provided input values.

Related Unions

  • MetafieldReference The resource referenced by the metafield value.
  • MetafieldReferencer Types of resources that may use metafields to reference other resources.

Examples