metafieldDefinitionDelete - admin-graphql - MUTATION

Version: 2025-01

Description:

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

Access Scopes

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

Arguments

• deleteAllAssociatedMetafields: Boolean - Whether to delete all associated metafields.
• id: ID! - The id of the metafield definition to delete.

Returns

• deletedDefinitionId: ID The ID of the deleted metafield definition.
• userErrors: MetafieldDefinitionDeleteUserError! The list of errors that occurred from executing the mutation.

Examples

• Delete a metafield definition

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) { metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) { deletedDefinitionId userErrors { field message code } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/MetafieldDefinition/1071456130\",\n    \"deleteAllAssociatedMetafields\": true\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {\n      metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {\n        deletedDefinitionId\n        userErrors {\n          field\n          message\n          code\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/MetafieldDefinition/1071456130\",\n      \"deleteAllAssociatedMetafields\": true\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {\n    metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {\n      deletedDefinitionId\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/MetafieldDefinition/1071456130\",\n  \"deleteAllAssociatedMetafields\": true\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {\n    metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {\n      deletedDefinitionId\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/MetafieldDefinition/1071456130\",\n  \"deleteAllAssociatedMetafields\" => true,\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {\n    metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {\n      deletedDefinitionId\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/MetafieldDefinition/1071456130\",\n      \"deleteAllAssociatedMetafields\": true\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {\n  metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {\n    deletedDefinitionId\n    userErrors {\n      field\n      message\n      code\n    }\n  }\n}"
        

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

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