metafieldDefinitionDelete

mutation

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

Delete a metafield definition. Optionally deletes all associated metafields asynchronously when specified.

Arguments

Anchor to deleteAllAssociatedMetafieldsdeleteAllAssociatedMetafields • BooleanDefault:false: Whether to delete all associated metafields.
Anchor to idid • ID!required: The id of the metafield definition to delete.

Was this section helpful?

Anchor to MetafieldDefinitionDeletePayload returnsMetafieldDefinitionDeletePayload returns

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?

Delete a metafield definition
metafieldDefinitionDelete reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {
6    metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {
7      deletedDefinitionId
8      userErrors {
9        field
10        message
11        code
12      }
13    }
14  }`,
15  {
16    variables: {
17      "id": "gid://shopify/MetafieldDefinition/1071456130",
18      "deleteAllAssociatedMetafields": true
19    },
20  },
21);
22
23const data = await response.json();
24

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/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
  }
}'

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 data = await response.json();

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
    },
  },
});

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

1{
2  "id": "gid://shopify/MetafieldDefinition/1071456130",
3  "deleteAllAssociatedMetafields": true
4}

Response

JSON

1{
2  "metafieldDefinitionDelete": {
3    "deletedDefinitionId": "gid://shopify/MetafieldDefinition/1071456130",
4    "userErrors": []
5  }
6}