Skip to main content
Log inSign up
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.

•
DateTime!non-null

The date and time when the private metafield was created.

•
ID!non-null

The ID of the private metafield.

•
String!non-null

The key name of the private metafield.

•
String!non-null

The namespace of the private metafield.

•
DateTime!non-null

The date and time when the private metafield was updated.

•
String!non-null

The value of a private metafield.

•

Represents the private metafield value type.


Was this section helpful?

Show
deprecated queries Deprecated
•
queryDeprecated

Returns a private metafield by ID. Private metafields are accessible only by the application that created them. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.

•
queryDeprecated

Returns a list of private metafields associated to a resource. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.


Was this section helpful?

•
mutationDeprecated

Creates or updates a private metafield. Use private metafields when you don't want the metafield data to be accessible by merchants or other apps. 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. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.


Was this section helpful?

•
interface

Was this section helpful?