themeFilesDelete

mutation

Requires The user needs write_themes and an exemption from Shopify to modify theme files. If you think that your app is eligible for an exemption and should have access to this API, then you can submit an exception request.

Deletes a theme's files.

Arguments

Anchor to filesfiles • [String!]!required: The files to delete.
Anchor to themeIdthemeId • ID!required: Specifies the theme to deleted.

Was this section helpful?

Anchor to ThemeFilesDeletePayload returnsThemeFilesDeletePayload returns

Anchor to deletedThemeFilesdeletedThemeFiles • [OnlineStoreThemeFileOperationResult!]: The resulting theme files.
Anchor to userErrorsuserErrors • [OnlineStoreThemeFilesUserErrors!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Delete a theme file
Deletes an asset from a theme
themeFilesDelete reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation themeFilesDelete($themeId: ID!, $files: [String!]!) {
6    themeFilesDelete(themeId: $themeId, files: $files) {
7      deletedThemeFiles {
8        filename
9      }
10      userErrors {
11        field
12        message
13      }
14    }
15  }`,
16  {
17    variables: {
18      "themeId": "gid://shopify/OnlineStoreTheme/529529152",
19      "files": [
20        "templates/index.json"
21      ]
22    },
23  },
24);
25
26const data = await response.json();
27

mutation themeFilesDelete($themeId: ID!, $files: [String!]!) {
  themeFilesDelete(themeId: $themeId, files: $files) {
    deletedThemeFiles {
      filename
    }
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation themeFilesDelete($themeId: ID!, $files: [String!]!) { themeFilesDelete(themeId: $themeId, files: $files) { deletedThemeFiles { filename } userErrors { field message } } }",
 "variables": {
    "themeId": "gid://shopify/OnlineStoreTheme/529529152",
    "files": [
      "templates/index.json"
    ]
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation themeFilesDelete($themeId: ID!, $files: [String!]!) {
    themeFilesDelete(themeId: $themeId, files: $files) {
      deletedThemeFiles {
        filename
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "themeId": "gid://shopify/OnlineStoreTheme/529529152",
      "files": [
        "templates/index.json"
      ]
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation themeFilesDelete($themeId: ID!, $files: [String!]!) {
      themeFilesDelete(themeId: $themeId, files: $files) {
        deletedThemeFiles {
          filename
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "themeId": "gid://shopify/OnlineStoreTheme/529529152",
      "files": [
        "templates/index.json"
      ]
    },
  },
});

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 themeFilesDelete($themeId: ID!, $files: [String!]!) {
    themeFilesDelete(themeId: $themeId, files: $files) {
      deletedThemeFiles {
        filename
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "themeId": "gid://shopify/OnlineStoreTheme/529529152",
  "files": ["templates/index.json"]
}

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

Input variables

JSON

1{
2  "themeId": "gid://shopify/OnlineStoreTheme/529529152",
3  "files": [
4    "templates/index.json"
5  ]
6}

Response

JSON

1{
2  "themeFilesDelete": {
3    "deletedThemeFiles": [
4      {
5        "filename": "templates/index.json"
6      }
7    ],
8    "userErrors": []
9  }
10}