User
Represents an error in the input of a mutation.
Anchor to FieldsFields
- field ([String!]!)
- message (String!)
- Anchor to fieldfield•[String!]!non-null
Path to input field which caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- fetchCustomDataTokenForUser (FetchCustomDataTokenForUserPayload)
- mediaCreate (MediaCreatePayload)
- mediaDelete (MediaDeletePayload)
- mediaUpdate (MediaUpdatePayload)
- metafieldAccessGrant (MetafieldAccessGrantPayload)
- metafieldAccessRevoke (MetafieldAccessRevokePayload)
- metafieldDefinitionCreate (MetafieldDefinitionCreatePayload)
- metafieldDefinitionDelete (MetafieldDefinitionDeletePayload)
- metafieldDefinitionUpdate (MetafieldDefinitionUpdatePayload)
- metafieldNamespaceCreate (MetafieldNamespaceCreatePayload)
- metafieldNamespaceDelete (MetafieldNamespaceDeletePayload)
- metafieldNamespaceUpdate (MetafieldNamespaceUpdatePayload)
- standardMetafieldDefinitionEnable (StandardMetafieldDefinitionEnablePayload)
- •mutation
Fetch an OAuth Access and Refresh Token pair for the Shop Users API to read or write metafields after user's presence interaction ends.
If a user has used Sign in with Shop with your App client, you may retreive tokens to read / write your own metafields on a user.
- Anchor to emailemail•String!required
The email of the buyer for whom you need an Access token.
- Anchor to throughthrough•String
Private to Shopify Internal clients. Allows a storefront to be passed in by its myshopify domain.
Arguments
- •mutation
Create a new shop video with related products.
- Anchor to inputinput•Media
Create Input! required
Arguments
- •mutation
Delete a shop video (soft delete).
- •ID!required
The video ID in GID format (e.g., gid://shopapp/ShopVideo/ea9088eb-9a19-45b8-9d2c-5ca2b8ae13d1).
Arguments
- •ID!
- •mutation
Update an existing shop video.
- Anchor to inputinput•Media
Update Input! required
Arguments
- •mutation
Share a Metafield Primitive with a Client or Namespace. Requires the 'share_metafield' client scope and requires that the Client making the request has Admin permission on the Resource.
- Anchor to accessaccess•Custom
Data Access Input! required Update the default permission of the resource and/or provide a list of targets to give access to the resource.
- Anchor to identifieridentifier•Custom
Data Key Pair Input! required Key and namespace pair that together form the path to the resource. Key is required, Namespace defaults to the Client's implicit, reserved namespace if not provided.
- •String
Use 'key' to provide a new key for the target when sharing, if desired. Only changes the key for the newly shared resource within the grantee's reserved namespace, not the grantor's.
Arguments
- •mutation
Revoke shared access between a Metafield Primitive and a Client or Namespace for Primitives of which your Client is an Admin.
- Anchor to identifieridentifier•Custom
Data Key Pair Input! required Key and namespace pair that together form the path to the resource. Key is required, Namespace defaults to the Client's implicit, reserved namespace if not provided.
- Anchor to targetstargets•[Target
Input!]! required A list of targets for whom to revoke access from the given resource.
Arguments
- •mutation
Create a new MetafieldDefinition.
- Anchor to definitiondefinition•Metafield
Definition Create Input! required
Arguments
- •mutation
Remove a MetafieldDefinition and cascade delete all associated Metafields.
- 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 definition. This is applicable in cases where the desired definition is nested within namespaces. In the absence of a providednamespace, the system will default to the client's implicit, reserved namespace.
Arguments
- •mutation
Update a MetafieldDefinition by changing its key, name, description, capabilities, or access.
- Anchor to definitiondefinition•Metafield
Definition Update Input! required
Arguments
- •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
- •mutation
TK - Not implemented.
- •String!required
- Anchor to namespacenamespace•String!required
Arguments
- •String!