Metaobject User Error
Defines errors encountered while managing metaobject resources.
Anchor to FieldsFields
- Anchor to codecode•Metaobject
User Error Code The error code.
- Anchor to elementIndexelement•Int
Index The index of the failing list element in an array.
- Anchor to elementKeyelement•String
Key The key of the failing object element.
- Anchor to fieldfield•[String!]
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- •mutation
Asynchronously delete metaobjects and their associated metafields in bulk.
- Anchor to wherewhere•Metaobject
Bulk Delete Where Condition! required Specifies the condition by which metaobjects are deleted. Exactly one field of input is required.
Arguments
- •mutation
Creates a metaobject entry based on an existing
. 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.
- Anchor to metaobjectmetaobject•Metaobject
Create Input! required The parameters for the metaobject to create.
Arguments
- •mutation
Creates a metaobject definition that establishes the structure for custom data objects in your store. The definition specifies the fields, data types, and access permissions that all
Metaobjectentries of this type share.Use the
typefield to create a unique namespace for your metaobjects. Prefix the type with$app:to reserve the definition for your app's exclusive use. The definition can include capabilities like publishable status or translation eligibility, to extend how metaobjects integrate with Shopify's features.Learn more about managing metaobjects.
- Anchor to definitiondefinition•Metaobject
Definition Create Input! required The input fields for creating a metaobject definition.
Arguments
- •mutation
Deletes the specified metaobject definition. Also deletes all related metafield definitions, metaobjects, and metafields asynchronously.
- •ID!required
The ID of the metaobjects definition to delete.
Arguments
- •ID!
- •mutation
Updates a
's configuration and field structure. You can modify the definition's name, description, display name key, access controls, and capabilities, as well as those of all its fields.The mutation supports reordering fields when
istrue, which arranges submitted fields first followed by alphabetized omitted fields.Learn more about managing metaobjects.
- •ID!required
The ID of the metaobject definition to update.
- Anchor to definitiondefinition•Metaobject
Definition Update Input! required The input fields for updating a metaobject definition.
Arguments
- •ID!
- •mutation
Deletes the specified metaobject and its associated metafields.
- •ID!required
The ID of the metaobject to delete.
Arguments
- •ID!
- •mutation
Updates a
Metaobjectwith 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
, 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.- •ID!required
The ID of the metaobject to update.
- Anchor to metaobjectmetaobject•Metaobject
Update Input! required Specifies parameters to update on the metaobject.
Arguments
- •ID!
- •mutation
Creates or updates a
Metaobjectbased 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
's field keys and overwrite existing values during updates.- Anchor to handlehandle•Metaobject
Handle Input! required The identifier of the metaobject to upsert.
- Anchor to metaobjectmetaobject•Metaobject
Upsert Input! required The parameters to upsert the metaobject.
Arguments
- •mutation
Enables the specified standard metaobject definition from its template.
- Anchor to typetype•String!required
The type of the metaobject definition to enable.
Arguments