Choose a version:

metafieldDefinitionDelete

mutation

Requires API client to have access to the resource type associated with the metafield definition.

Deletes a MetafieldDefinition. You can identify the definition by providing either its owner type, namespace, and key, or its global ID.

When you set deleteAllAssociatedMetafields to true, the mutation asynchronously deletes all Metafield objects that use this definition. This option must be true when deleting definitions under the $app namespace.

Learn more about deleting metafield definitions.

Anchor to Arguments

Arguments

Anchor to deleteAllAssociatedMetafieldsdeleteAllAssociatedMetafields

•Boolean

Default:false

Whether to delete all associated metafields.

Anchor to idid

•ID

The id of the metafield definition to delete. Using identifier is preferred.

Anchor to identifieridentifier

•MetafieldDefinitionIdentifierInput

The identifier of the metafield definition to delete.

Was this section helpful?

Anchor to MetafieldDefinitionDeletePayload returnsMetafieldDefinitionDeletePayload returns

Anchor to deletedDefinitiondeletedDefinition •MetafieldDefinitionIdentifier: The metafield definition that was deleted.
Anchor to deletedDefinitionIddeletedDefinitionId •ID: The ID of the deleted metafield definition.
Anchor to userErrorsuserErrors •[MetafieldDefinitionDeleteUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Delete a metafield definition

Description

To delete a metafield definition, use the `metafieldDefinitionDelete` mutation. The following example shows how to delete the metafield definition for `bakery.ingredients`, and also deletes all metafields that use the definition.

Query

mutation DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {
  metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {
    deletedDefinitionId
    userErrors {
      field
      message
      code
    }
  }
}

Variables

{
  "id": "gid://shopify/MetafieldDefinition/1071456130",
  "deleteAllAssociatedMetafields": true
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) { metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) { deletedDefinitionId userErrors { field message code } } }",
 "variables": {
    "id": "gid://shopify/MetafieldDefinition/1071456130",
    "deleteAllAssociatedMetafields": true
  }
}'

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 DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {
    metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {
      deletedDefinitionId
      userErrors {
        field
        message
        code
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/MetafieldDefinition/1071456130",
        "deleteAllAssociatedMetafields": true
    },
  },
  );
  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 DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {
    metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {
      deletedDefinitionId
      userErrors {
        field
        message
        code
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/MetafieldDefinition/1071456130",
  "deleteAllAssociatedMetafields": true
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {
      metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {
        deletedDefinitionId
        userErrors {
          field
          message
          code
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/MetafieldDefinition/1071456130",
        "deleteAllAssociatedMetafields": true
    },
  },
});

Response

{
  "metafieldDefinitionDelete": {
    "deletedDefinitionId": "gid://shopify/MetafieldDefinition/1071456130",
    "userErrors": []
  }
}

metafieldDefinitionDelete 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 DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {

metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {

deletedDefinitionId

userErrors {

field

message

code

}

}`,

{

variables: {

"id": "gid://shopify/MetafieldDefinition/1071456130",

"deleteAllAssociatedMetafields": true

);

const json = await response.json();

return json.data;

}

GQL

mutation DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {
  metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {
    deletedDefinitionId
    userErrors {
      field
      message
      code
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) { metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) { deletedDefinitionId userErrors { field message code } } }",
 "variables": {
    "id": "gid://shopify/MetafieldDefinition/1071456130",
    "deleteAllAssociatedMetafields": true
  }
}'

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 DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {
    metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {
      deletedDefinitionId
      userErrors {
        field
        message
        code
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/MetafieldDefinition/1071456130",
        "deleteAllAssociatedMetafields": true
    },
  },
  );
  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 DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {
      metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {
        deletedDefinitionId
        userErrors {
          field
          message
          code
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/MetafieldDefinition/1071456130",
        "deleteAllAssociatedMetafields": true
    },
  },
});

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 DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {
    metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {
      deletedDefinitionId
      userErrors {
        field
        message
        code
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/MetafieldDefinition/1071456130",
  "deleteAllAssociatedMetafields": true
}

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

Input variables

JSON

{

"id": "gid://shopify/MetafieldDefinition/1071456130",

"deleteAllAssociatedMetafields": true

}

Response

JSON

{

"metafieldDefinitionDelete": {

"deletedDefinitionId": "gid://shopify/MetafieldDefinition/1071456130",

"userErrors": []

}