fileDelete

mutation

Requires write_files access scope. Also: Users must have delete files permissions.

Deletes existing file assets that were uploaded to Shopify.

Arguments

Anchor to fileIdsfileIds • [ID!]!required: The IDs of the files to be deleted.

Was this section helpful?

Anchor to FileDeletePayload returnsFileDeletePayload returns

Anchor to deletedFileIdsdeletedFileIds • [ID!]: The IDs of the deleted files.
Anchor to userErrorsuserErrors • [FilesUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Delete a list of files
Deleting a file that doesn't exist returns an error
fileDelete reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation fileDelete($input: [ID!]!) {
6    fileDelete(fileIds: $input) {
7      deletedFileIds
8    }
9  }`,
10  {
11    variables: {
12      "input": [
13        "gid://shopify/GenericFile/1072273199",
14        "gid://shopify/MediaImage/1072273200",
15        "gid://shopify/Video/1072273201"
16      ]
17    },
18  },
19);
20
21const data = await response.json();
22

mutation fileDelete($input: [ID!]!) {
  fileDelete(fileIds: $input) {
    deletedFileIds
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation fileDelete($input: [ID!]!) { fileDelete(fileIds: $input) { deletedFileIds } }",
 "variables": {
    "input": [
      "gid://shopify/GenericFile/1072273199",
      "gid://shopify/MediaImage/1072273200",
      "gid://shopify/Video/1072273201"
    ]
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation fileDelete($input: [ID!]!) {
    fileDelete(fileIds: $input) {
      deletedFileIds
    }
  }`,
  {
    variables: {
      "input": [
        "gid://shopify/GenericFile/1072273199",
        "gid://shopify/MediaImage/1072273200",
        "gid://shopify/Video/1072273201"
      ]
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation fileDelete($input: [ID!]!) {
      fileDelete(fileIds: $input) {
        deletedFileIds
      }
    }`,
    "variables": {
      "input": [
        "gid://shopify/GenericFile/1072273199",
        "gid://shopify/MediaImage/1072273200",
        "gid://shopify/Video/1072273201"
      ]
    },
  },
});

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 fileDelete($input: [ID!]!) {
    fileDelete(fileIds: $input) {
      deletedFileIds
    }
  }
QUERY

variables = {
  "input": ["gid://shopify/GenericFile/1072273199", "gid://shopify/MediaImage/1072273200", "gid://shopify/Video/1072273201"]
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "input": [
3    "gid://shopify/GenericFile/1072273199",
4    "gid://shopify/MediaImage/1072273200",
5    "gid://shopify/Video/1072273201"
6  ]
7}

Response

JSON

1{
2  "fileDelete": {
3    "deletedFileIds": [
4      "gid://shopify/GenericFile/1072273199",
5      "gid://shopify/MediaImage/1072273200",
6      "gid://shopify/Video/1072273201"
7    ]
8  }
9}