Anchor to section titled 'undefined'metaobject
metaobject
mutation
2024-04
Requires write access scope.
Deletes the specified metaobject and its associated metafields.
Anchor to section titled 'Arguments'
Arguments
The ID of the metaobject to delete.
Was this section helpful?
Anchor to section titled 'MetaobjectDeletePayload returns'
MetaobjectDeletePayload returns
The ID of the deleted metaobject.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: metaobjectDelete
Query Reference for MUTATION: metaobjectDelete
"mutation metaobjectDelete($id: ID!) {\n metaobjectDelete(id: $id) {\n deletedId\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: metaobjectDelete
"{\n \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"Schema Reference for MUTATION: metaobjectDelete
""
Display Examples for MUTATION: metaobjectDelete
[
{
"example": {
"type_name": "metaobjectdelete",
"title": "Deletes a metaobject",
"description": "Delete an existing metaobject using its ID.\n",
"query_string": "mutation DeleteMetaobject($id: ID!) {\n metaobjectDelete(id: $id) {\n deletedId\n userErrors {\n field\n message\n code\n }\n }\n}",
"variables": {
"id": "gid://shopify/Metaobject/515107504"
},
"response": {
"data": {
"metaobjectDelete": {
"deletedId": "gid://shopify/Metaobject/515107504",
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/content/metaobjects/test/unit/graph_api/admin/mutations/metaobject_delete_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation DeleteMetaobject($id: ID!) { metaobjectDelete(id: $id) { deletedId userErrors { field message code } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/Metaobject/515107504\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation DeleteMetaobject($id: ID!) {\n metaobjectDelete(id: $id) {\n deletedId\n userErrors {\n field\n message\n code\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/Metaobject/515107504\"\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 DeleteMetaobject($id: ID!) {\n metaobjectDelete(id: $id) {\n deletedId\n userErrors {\n field\n message\n code\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/Metaobject/515107504\"\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 DeleteMetaobject($id: ID!) {\n metaobjectDelete(id: $id) {\n deletedId\n userErrors {\n field\n message\n code\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/Metaobject/515107504\"\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 DeleteMetaobject($id: ID!) {\n metaobjectDelete(id: $id) {\n deletedId\n userErrors {\n field\n message\n code\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/Metaobject/515107504\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the metaobject 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/Metaobject/515107504\"",
"typeKind": "MUTATION"
}
]
}
]