Anchor to section titled 'undefined'file
file
mutation
Unstable
Requires write access scope.
Deletes existing file assets that were uploaded to Shopify.
Anchor to section titled 'Arguments'
Arguments
The IDs of the files to be deleted.
Was this section helpful?
Anchor to section titled 'FileDeletePayload returns'
FileDeletePayload returns
- Anchor to FileDeletePayload.deletedFileIdsdeleted
File Ids The IDs of the deleted files.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: fileDelete
Query Reference for MUTATION: fileDelete
"mutation fileDelete($fileIds: [ID!]!) {\n fileDelete(fileIds: $fileIds) {\n deletedFileIds\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: fileDelete
"{\n \"fileIds\": [\n \"gid://shopify/<objectName>/10079785100\"\n ]\n}"Schema Reference for MUTATION: fileDelete
""
Display Examples for MUTATION: fileDelete
[
{
"example": {
"type_name": "filedelete",
"title": "Delete a list of files",
"description": "Deletes a list of files given their IDs and returns the deleted IDs",
"query_string": "mutation fileDelete($input: [ID!]!) {\n fileDelete(fileIds: $input) {\n deletedFileIds\n }\n}",
"variables": {
"input": [
"gid://shopify/GenericFile/1072273199",
"gid://shopify/MediaImage/1072273200",
"gid://shopify/Video/1072273201"
]
},
"response": {
"data": {
"fileDelete": {
"deletedFileIds": [
"gid://shopify/GenericFile/1072273199",
"gid://shopify/MediaImage/1072273200",
"gid://shopify/Video/1072273201"
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/file_delete_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation fileDelete($input: [ID!]!) { fileDelete(fileIds: $input) { deletedFileIds } }\",\n \"variables\": {\n \"input\": [\n \"gid://shopify/GenericFile/1072273199\",\n \"gid://shopify/MediaImage/1072273200\",\n \"gid://shopify/Video/1072273201\"\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation fileDelete($input: [ID!]!) {\n fileDelete(fileIds: $input) {\n deletedFileIds\n }\n }`,\n {\n variables: {\n \"input\": [\n \"gid://shopify/GenericFile/1072273199\",\n \"gid://shopify/MediaImage/1072273200\",\n \"gid://shopify/Video/1072273201\"\n ]\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 fileDelete($input: [ID!]!) {\n fileDelete(fileIds: $input) {\n deletedFileIds\n }\n }\nQUERY\n\nvariables = {\n \"input\": [\"gid://shopify/GenericFile/1072273199\", \"gid://shopify/MediaImage/1072273200\", \"gid://shopify/Video/1072273201\"]\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 fileDelete($input: [ID!]!) {\n fileDelete(fileIds: $input) {\n deletedFileIds\n }\n }`,\n \"variables\": {\n \"input\": [\n \"gid://shopify/GenericFile/1072273199\",\n \"gid://shopify/MediaImage/1072273200\",\n \"gid://shopify/Video/1072273201\"\n ]\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 fileDelete($input: [ID!]!) {\n fileDelete(fileIds: $input) {\n deletedFileIds\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\"gid://shopify/GenericFile/1072273199\", \"gid://shopify/MediaImage/1072273200\", \"gid://shopify/Video/1072273201\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": []
},
{
"example": {
"type_name": "filedelete",
"title": "Deleting a file that doesn't exist returns an error",
"description": "Attempting to delete a file by an ID that does not exist returns an error",
"query_string": "mutation fileDelete($input: [ID!]!) {\n fileDelete(fileIds: $input) {\n deletedFileIds\n userErrors {\n message\n }\n }\n}",
"variables": {
"input": [
"gid://shopify/GenericFile/1"
]
},
"response": {
"data": {
"fileDelete": {
"deletedFileIds": null,
"userErrors": [
{
"message": "File id gid://shopify/GenericFile/1 does not exist."
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/file_delete_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation fileDelete($input: [ID!]!) { fileDelete(fileIds: $input) { deletedFileIds userErrors { message } } }\",\n \"variables\": {\n \"input\": [\n \"gid://shopify/GenericFile/1\"\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation fileDelete($input: [ID!]!) {\n fileDelete(fileIds: $input) {\n deletedFileIds\n userErrors {\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": [\n \"gid://shopify/GenericFile/1\"\n ]\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 fileDelete($input: [ID!]!) {\n fileDelete(fileIds: $input) {\n deletedFileIds\n userErrors {\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": [\"gid://shopify/GenericFile/1\"]\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 fileDelete($input: [ID!]!) {\n fileDelete(fileIds: $input) {\n deletedFileIds\n userErrors {\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": [\n \"gid://shopify/GenericFile/1\"\n ]\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 fileDelete($input: [ID!]!) {\n fileDelete(fileIds: $input) {\n deletedFileIds\n userErrors {\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\"gid://shopify/GenericFile/1\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": []
}
]