Metaobject
Requires access scope.
Provides an object instance represented by a MetaobjectDefinition.
Anchor to Fields and connectionsFields and connections
- Anchor to capabilitiescapabilities•Metaobject
Capability Data!non-null Metaobject capabilities for this Metaobject.
- Anchor to createdBycreated•App!non-null
By The app used to create the object.
- Anchor to createdByAppcreated•App!non-null
By App The app used to create the object.
- Anchor to createdByStaffcreated•Staff
By Staff Member The staff member who created the metaobject.
- Anchor to definitiondefinition•Metaobject
Definition!non-null The MetaobjectDefinition that models this object type.
- Anchor to displayNamedisplay•String!non-null
Name The preferred display name field value of the metaobject.
- Anchor to fieldfield•Metaobject
Field The field for an object key, or null if the key has no field definition.
- Anchor to fieldsfields•[Metaobject
Field!]!non-null All ordered fields of the metaobject with their definitions and values.
- Anchor to handlehandle•String!non-null
The unique handle of the object, useful as a custom ID.
- •ID!non-null
A globally-unique ID.
- Anchor to referencedByreferenced•Metafield
By Relation Connection!non-null List of back references metafields that belong to the resource.
- Anchor to thumbnailFieldthumbnail•Metaobject
Field Field The recommended field to visually represent this metaobject. May be a file reference or color field.
- Anchor to typetype•String!non-null
The type of the metaobject.
- Anchor to updatedAtupdated•Date
At Time!non-null When the object was last updated.
- Anchor to staffMemberstaff•Staff
Member MemberDeprecated
Anchor to QueriesQueries
- •query
Retrieves a metaobject by ID.
- •query
Retrieves a metaobject by handle.
- •query
All metaobjects for the shop.
Anchor to MutationsMutations
- •mutation
Creates a new metaobject.
- Anchor to metaobjectmetaobject•Metaobject
Create Input!required The parameters for the metaobject to create.
Arguments
- Anchor to metaobjectmetaobject•Metaobject
The created metaobject.
- Anchor to userErrorsuser•[Metaobject
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates an existing metaobject.
- •ID!required
The ID of the metaobject to update.
- Anchor to metaobjectmetaobject•Metaobject
Update Input!required Specifies parameters to update on the metaobject.
Arguments
- Anchor to metaobjectmetaobject•Metaobject
The updated metaobject.
- Anchor to userErrorsuser•[Metaobject
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
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.
- 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
- Anchor to metaobjectmetaobject•Metaobject
The created or updated metaobject.
- Anchor to userErrorsuser•[Metaobject
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields