Anchor to section titled 'undefined'metafield
metafield
mutation
2024-10latest
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.
Anchor to section titled 'Arguments'
Arguments
Whether to delete all associated metafields.
The id of the metafield definition to delete.
Was this section helpful?
Anchor to section titled 'MetafieldDefinitionDeletePayload returns'
MetafieldDefinitionDeletePayload returns
- Anchor to MetafieldDefinitionDeletePayload.deletedDefinitionIddeleted
Definition Id The ID of the deleted metafield definition.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: metafieldDefinitionDelete
Query Reference for MUTATION: metafieldDefinitionDelete
"mutation metafieldDefinitionDelete($id: ID!) {\n metafieldDefinitionDelete(id: $id) {\n deletedDefinitionId\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: metafieldDefinitionDelete
"{\n \"deleteAllAssociatedMetafields\": true,\n \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"Schema Reference for MUTATION: metafieldDefinitionDelete
""
Display Examples for MUTATION: metafieldDefinitionDelete
[
{
"example": {
"type_name": "metafielddefinitiondelete",
"title": "Delete a metafield definition",
"description": "To delete a metafield definition, use the `metafieldDefinitionDelete` mutation.\nThe following example shows how to delete the metafield definition for `bakery.ingredients`, and also\ndeletes all metafields that use the definition.\n",
"query_string": "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}",
"variables": {
"id": "gid://shopify/MetafieldDefinition/1071456130",
"deleteAllAssociatedMetafields": true
},
"response": {
"data": {
"metafieldDefinitionDelete": {
"deletedDefinitionId": "gid://shopify/MetafieldDefinition/1071456130",
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/content/metafields/test/unit/graph_api/admin/mutations/metafield_definition_delete_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/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",
"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",
"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",
"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",
"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"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The id of the metafield definition to delete.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/MetafieldDefinition/1071456130\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "deleteAllAssociatedMetafields",
"description": "Whether to delete all associated metafields.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"list": false,
"non_null": false
},
"defaultValue": "false",
"typeSignature": "Boolean",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "deleteAllAssociatedMetafields",
"argValue": " true",
"typeKind": "MUTATION"
}
]
}
]