Metafield
A MetafieldNamespace is a Permissible type. It is managed by a Client and defines a group of Custom Data primitives and permissions. Control and access of a MetafieldNamespace is determined by AccessGrants that link the Namespace to Clients or other Namespaces.
Anchor to FieldsFields
- access (CustomDataAccessType)
- description (String)
- key (String!)
- name (String)
- namespace (String)
- uuid (ID!)
- Anchor to accessaccess•Custom
Data Access Type List of the active policies associated with this Namespace. Policies represent ownership of the Namespace and can be granted to Clients and other Namespaces.
- Anchor to descriptiondescription•String
Developer facing description.
- •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.
Anchor to MutationsMutations
- metafieldNamespaceCreate (MetafieldNamespaceCreatePayload)
- metafieldNamespaceDelete (MetafieldNamespaceDeletePayload)
- metafieldNamespaceUpdate (MetafieldNamespaceUpdatePayload)
- •mutation
Create a new MetafieldNamespace.
Every client has their own implicit, reserved namespace; however, Namespaces allow sharing groups of Metafield Primitives and Access Grants together. Creating new Namespaces requires the client to have additional scope and is not available to all clients.
- Anchor to namespacenamespace•Metafield
Namespace Create Input! required
Arguments
- •mutation
Destroy a Namespace and remove any shared Access. MetafieldDefinitions shared to the Namespace will not be deleted, but their association with the namespace will be removed.
- Anchor to identifieridentifier•Custom
Data Key Pair Input! required This argument accepts an object that consists of a
keyand an optionalnamespace. Thekeyis a mandatory attribute that represents a specific element within a namespace. Thenamespaceattribute, if provided, should be a period-delimited string representing the hierarchical path to the desired namespace. This is applicable in cases where the desired namespace is nested within other namespaces. In the absence of a providednamespace, the system will default to the client's implicit, reserved namespace.
Arguments
- •mutation
Update a MetafieldNamespace by changing its key, name, description, capabilities, or access.
- Anchor to namespacenamespace•Metafield
Namespace Update Input! required
Arguments