Choose a version:

metafieldsDelete

mutation

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 Metafield objects in bulk by specifying combinations of owner ID, namespace, and key.

Returns the identifiers of successfully deleted metafields. If a specified metafield doesn't exist, then the mutation still succeeds but returns null for that identifier in the response.

Anchor to Arguments

Arguments

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

Was this section helpful?

Anchor to MetafieldsDeletePayload returnsMetafieldsDeletePayload returns

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

Was this section helpful?

Examples

Deletes a metafield by its ID

Query

mutation MetafieldsDelete($metafields: [MetafieldIdentifierInput!]!) {
  metafieldsDelete(metafields: $metafields) {
    deletedMetafields {
      key
      namespace
      ownerId
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "metafields": [
    {
      "ownerId": "gid://shopify/Product/20995642",
      "namespace": "inventory",
      "key": "today"
    }
  ]
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation MetafieldsDelete($metafields: [MetafieldIdentifierInput!]!) { metafieldsDelete(metafields: $metafields) { deletedMetafields { key namespace ownerId } userErrors { field message } } }",
 "variables": {
    "metafields": [
      {
        "ownerId": "gid://shopify/Product/20995642",
        "namespace": "inventory",
        "key": "today"
      }
    ]
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation MetafieldsDelete($metafields: [MetafieldIdentifierInput!]!) {
    metafieldsDelete(metafields: $metafields) {
      deletedMetafields {
        key
        namespace
        ownerId
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "metafields": [
            {
                "ownerId": "gid://shopify/Product/20995642",
                "namespace": "inventory",
                "key": "today"
            }
        ]
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation MetafieldsDelete($metafields: [MetafieldIdentifierInput!]!) {
    metafieldsDelete(metafields: $metafields) {
      deletedMetafields {
        key
        namespace
        ownerId
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "metafields": [
    {
      "ownerId": "gid://shopify/Product/20995642",
      "namespace": "inventory",
      "key": "today"
    }
  ]
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation MetafieldsDelete($metafields: [MetafieldIdentifierInput!]!) {
      metafieldsDelete(metafields: $metafields) {
        deletedMetafields {
          key
          namespace
          ownerId
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "metafields": [
            {
                "ownerId": "gid://shopify/Product/20995642",
                "namespace": "inventory",
                "key": "today"
            }
        ]
    },
  },
});

Response

{
  "metafieldsDelete": {
    "deletedMetafields": [
      {
        "key": "today",
        "namespace": "inventory",
        "ownerId": "gid://shopify/Product/20995642"
      }
    ],
    "userErrors": []
  }
}

metafieldsDelete reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation MetafieldsDelete($metafields: [MetafieldIdentifierInput!]!) {

metafieldsDelete(metafields: $metafields) {

deletedMetafields {

key

namespace

ownerId

}

userErrors {

field

message

}

}`,

{

variables: {

"metafields": [

{

"ownerId": "gid://shopify/Product/20995642",

"namespace": "inventory",

"key": "today"

}

]

);

const json = await response.json();

return json.data;

}

GQL

mutation MetafieldsDelete($metafields: [MetafieldIdentifierInput!]!) {
  metafieldsDelete(metafields: $metafields) {
    deletedMetafields {
      key
      namespace
      ownerId
    }
    userErrors {
      field
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation MetafieldsDelete($metafields: [MetafieldIdentifierInput!]!) { metafieldsDelete(metafields: $metafields) { deletedMetafields { key namespace ownerId } userErrors { field message } } }",
 "variables": {
    "metafields": [
      {
        "ownerId": "gid://shopify/Product/20995642",
        "namespace": "inventory",
        "key": "today"
      }
    ]
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation MetafieldsDelete($metafields: [MetafieldIdentifierInput!]!) {
    metafieldsDelete(metafields: $metafields) {
      deletedMetafields {
        key
        namespace
        ownerId
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "metafields": [
            {
                "ownerId": "gid://shopify/Product/20995642",
                "namespace": "inventory",
                "key": "today"
            }
        ]
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation MetafieldsDelete($metafields: [MetafieldIdentifierInput!]!) {
      metafieldsDelete(metafields: $metafields) {
        deletedMetafields {
          key
          namespace
          ownerId
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "metafields": [
            {
                "ownerId": "gid://shopify/Product/20995642",
                "namespace": "inventory",
                "key": "today"
            }
        ]
    },
  },
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation MetafieldsDelete($metafields: [MetafieldIdentifierInput!]!) {
    metafieldsDelete(metafields: $metafields) {
      deletedMetafields {
        key
        namespace
        ownerId
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "metafields": [
    {
      "ownerId": "gid://shopify/Product/20995642",
      "namespace": "inventory",
      "key": "today"
    }
  ]
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"metafields": [

{

"ownerId": "gid://shopify/Product/20995642",

"namespace": "inventory",

"key": "today"

}

]

}

Response

JSON

{

"metafieldsDelete": {

"deletedMetafields": [

{

"key": "today",

"namespace": "inventory",

"ownerId": "gid://shopify/Product/20995642"

}

"userErrors": []

}