themeFilesDelete - admin-graphql - MUTATION

Version: 2024-10

Description:

Deletes a theme's files.

Access Scopes

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](https://docs.google.com/forms/d/e/1FAIpQLSfZTB1vxFC5d1-GPdqYunWRGUoDcOheHQzfK2RoEFEHrknt5g/viewform).

Arguments

• files: String! - The files to delete.
• themeId: ID! - Specifies the theme to deleted.

Returns

• deletedThemeFiles: OnlineStoreThemeFileOperationResult The resulting theme files.
• userErrors: OnlineStoreThemeFilesUserErrors! The list of errors that occurred from executing the mutation.

Examples

• Delete a theme file

          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 themeFilesDelete($themeId: ID!, $files: [String!]!) { themeFilesDelete(themeId: $themeId, files: $files) { deletedThemeFiles { filename } userErrors { field message } } }\",\n \"variables\": {\n    \"themeId\": \"gid://shopify/OnlineStoreTheme/529529152\",\n    \"files\": [\n      \"templates/index.json\"\n    ]\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation themeFilesDelete($themeId: ID!, $files: [String!]!) {\n      themeFilesDelete(themeId: $themeId, files: $files) {\n        deletedThemeFiles {\n          filename\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"themeId\": \"gid://shopify/OnlineStoreTheme/529529152\",\n      \"files\": [\n        \"templates/index.json\"\n      ]\n    },\n  },\n});\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 themeFilesDelete($themeId: ID!, $files: [String!]!) {\n    themeFilesDelete(themeId: $themeId, files: $files) {\n      deletedThemeFiles {\n        filename\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"themeId\": \"gid://shopify/OnlineStoreTheme/529529152\",\n  \"files\": [\"templates/index.json\"]\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation themeFilesDelete($themeId: ID!, $files: [String!]!) {\n    themeFilesDelete(themeId: $themeId, files: $files) {\n      deletedThemeFiles {\n        filename\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"themeId\" => \"gid://shopify/OnlineStoreTheme/529529152\",\n  \"files\" => [\"templates/index.json\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation themeFilesDelete($themeId: ID!, $files: [String!]!) {\n    themeFilesDelete(themeId: $themeId, files: $files) {\n      deletedThemeFiles {\n        filename\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"themeId\": \"gid://shopify/OnlineStoreTheme/529529152\",\n      \"files\": [\n        \"templates/index.json\"\n      ]\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation themeFilesDelete($themeId: ID!, $files: [String!]!) {\n  themeFilesDelete(themeId: $themeId, files: $files) {\n    deletedThemeFiles {\n      filename\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

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

  response: {
    "data": {
      "themeFilesDelete": {
        "deletedThemeFiles": [
          {
            "filename": "templates/index.json"
          }
        ],
        "userErrors": []
      }
    }
  }

  Deletes an asset from a theme

          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 ThemeFilesDelete($files: [String!]!, $themeId: ID!) { themeFilesDelete(files: $files, themeId: $themeId) { deletedThemeFiles { filename } userErrors { code field filename message } } }\",\n \"variables\": {\n    \"themeId\": \"gid://shopify/OnlineStoreTheme/529529152\",\n    \"files\": [\n      \"sections/content_section.liquid\"\n    ]\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation ThemeFilesDelete($files: [String!]!, $themeId: ID!) {\n      themeFilesDelete(files: $files, themeId: $themeId) {\n        deletedThemeFiles {\n          filename\n        }\n        userErrors {\n          code\n          field\n          filename\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"themeId\": \"gid://shopify/OnlineStoreTheme/529529152\",\n      \"files\": [\n        \"sections/content_section.liquid\"\n      ]\n    },\n  },\n});\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 ThemeFilesDelete($files: [String!]!, $themeId: ID!) {\n    themeFilesDelete(files: $files, themeId: $themeId) {\n      deletedThemeFiles {\n        filename\n      }\n      userErrors {\n        code\n        field\n        filename\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"themeId\": \"gid://shopify/OnlineStoreTheme/529529152\",\n  \"files\": [\"sections/content_section.liquid\"]\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation ThemeFilesDelete($files: [String!]!, $themeId: ID!) {\n    themeFilesDelete(files: $files, themeId: $themeId) {\n      deletedThemeFiles {\n        filename\n      }\n      userErrors {\n        code\n        field\n        filename\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"themeId\" => \"gid://shopify/OnlineStoreTheme/529529152\",\n  \"files\" => [\"sections/content_section.liquid\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation ThemeFilesDelete($files: [String!]!, $themeId: ID!) {\n    themeFilesDelete(files: $files, themeId: $themeId) {\n      deletedThemeFiles {\n        filename\n      }\n      userErrors {\n        code\n        field\n        filename\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"themeId\": \"gid://shopify/OnlineStoreTheme/529529152\",\n      \"files\": [\n        \"sections/content_section.liquid\"\n      ]\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation ThemeFilesDelete($files: [String!]!, $themeId: ID!) {\n  themeFilesDelete(files: $files, themeId: $themeId) {\n    deletedThemeFiles {\n      filename\n    }\n    userErrors {\n      code\n      field\n      filename\n      message\n    }\n  }\n}"
        

  input: {
    "themeId": "gid://shopify/OnlineStoreTheme/529529152",
    "files": [
      "sections/content_section.liquid"
    ]
  }

  response: {
    "data": {
      "themeFilesDelete": {
        "deletedThemeFiles": [
          {
            "filename": "sections/content_section.liquid"
          }
        ],
        "userErrors": []
      }
    }
  }