Choose a version:

CustomDataPermissible

interface

Defines the bases fields for a resource that can be shared. Used to provide a standard interface for access control Sharable resources are MetafieldDefinitions, MetafieldNamespaces, MetaObjects.

Anchor to FieldsFields

Anchor to descriptiondescription •String: Developer facing description.
Anchor to keykey •String! non-null: Developer facing identifier for the resource.
Anchor to namename •String: Developer facing display name.
Anchor to namespacenamespace •String: Developer facing path to identifier for the resource.
Anchor to uuiduuid •ID! non-null: Internal identifier for the resource.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to MetafieldDefinition MetafieldDefinition

•OBJECT

A MetafieldDefinition is a Permissible type. It is managed by a Client and defines the shape of the data stored in in a Metafield. Control and access of a MetafieldDefinition is determined by AccessGrants that link the definition to Clients or Namespaces.

Anchor to accessaccess •CustomDataAccessType: List of the active policies associated with this Definition. Policies represent ownership of the Definition and can be granted to Clients and Nampespaces.
Anchor to descriptiondescription •String: Developer facing description.
Anchor to keykey •String! non-null: Developer facing identifier for the resource.
Anchor to namename •String: Developer facing display name.
Anchor to namespacenamespace •String: Developer facing path to identifier for the resource.
Anchor to typetype •MetafieldDefinitionType! non-null: One of the types available in the Metafield developer documentation (https://shopify.dev/docs/apps/custom-data/metafields/types), except JSON.
Anchor to uuiduuid •ID! non-null: Internal identifier for the resource.
Anchor to validationsvalidations •[CustomDataMetafieldDefinitionValidationType!]: A list of validation options for the metafields that belong to the metafield definition.

Was this section helpful?

{

"description": "",

"key": "",

"name": "",

"namespace": "",

"uuid": ""

}

Variables

{
	"description": "",
	"key": "",
	"name": "",
	"namespace": "",
	"uuid": ""
}

Schema

interface CustomDataPermissible {
  description: String
  key: String!
  name: String
  namespace: String
  uuid: ID!
}