metafieldsDelete
mutation

Choose a version:

Requires access defined by each metafield input ownerId scalar's type in a MetafieldsSetInput field. For example, setting a metafield on a PRODUCT requires the same access as mutating a PRODUCT.

Deletes multiple metafields in bulk.

Anchor to section titled 'Arguments'

Arguments

Anchor to metafields metafields [MetafieldIdentifierInput!]! required: A list of identifiers specifying metafields to delete. At least one identifier must be specified.

Was this section helpful?

Anchor to section titled 'MetafieldsDeletePayload returns'

MetafieldsDeletePayload returns

Anchor to MetafieldsDeletePayload.deletedMetafields deletedMetafields [MetafieldIdentifier]: List of metafield identifiers that were deleted, null if the corresponding metafield isn't found.
Anchor to MetafieldsDeletePayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: metafieldsDelete

Query Reference for MUTATION: metafieldsDelete

"mutation metafieldsDelete($metafields: [MetafieldIdentifierInput!]!) {\n  metafieldsDelete(metafields: $metafields) {\n    deletedMetafields {\n      # MetafieldIdentifier fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: metafieldsDelete

"{\n  \"metafields\": [\n    {\n      \"key\": \"<your-key>\",\n      \"namespace\": \"<your-namespace>\",\n      \"ownerId\": \"gid://shopify/<objectName>/10079785100\"\n    }\n  ]\n}"

Schema Reference for MUTATION: metafieldsDelete

"input MetafieldIdentifierInput {\n  key: String!\n  namespace: String!\n  ownerId: ID!\n}\n"

Display Examples for MUTATION: metafieldsDelete

[]

metafieldsDeletemutation

Arguments

MetafieldsDeletePayload returns

metafieldsDelete
mutation