Skip to main content
Anchor to PrivateMetafield

PrivateMetafield

object

Private metafields represent custom metadata that is attached to a resource. Private metafields are accessible only by the application that created them and only from the GraphQL Admin API.

An application can create a maximum of 10 private metafields per shop resource.

Private metafields are deprecated. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.

Anchor to FieldsFields

Anchor to createdAtcreatedAt
•DateTime!
non-null

The date and time when the private metafield was created.

Anchor to idid
•ID!
non-null

The ID of the private metafield.

Anchor to keykey
•String!
non-null

The key name of the private metafield.

Anchor to namespacenamespace
•String!
non-null

The namespace of the private metafield.

Anchor to updatedAtupdatedAt
•DateTime!
non-null

The date and time when the private metafield was updated.

Anchor to valuevalue
•String!
non-null

The value of a private metafield.

Anchor to valueTypevalueType
•PrivateMetafieldValueType!
non-null

Represents the private metafield value type.

Was this section helpful?

Anchor to QueriesQueries

Deprecated queries

Anchor to privateMetafieldprivateMetafield
•query
Deprecated
Anchor to privateMetafieldsprivateMetafields
•query
Deprecated
Was this section helpful?

Anchor to MutationsMutations

Anchor to privateMetafieldUpsertprivateMetafieldUpsert
•mutation
Deprecated

Arguments

Anchor to inputinput
•PrivateMetafieldInput!
required

Specifies the input fields for the private metafield.

Fields

Anchor to privateMetafieldprivateMetafield
•PrivateMetafield

The private metafield that was created or updated.

Anchor to userErrorsuserErrors
•[UserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to NodeNode
•interface
Was this section helpful?