Choose a version:

themeFilesCopy

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.

Copy theme files. Copying to existing theme files will overwrite them.

Anchor to Arguments

Arguments

Anchor to filesfiles

•[ThemeFilesCopyFileInput!]!

required

The files to update.

Show input fields

Anchor to themeIdthemeId

•ID!

required

The theme to update.

Was this section helpful?

Anchor to ThemeFilesCopyPayload returnsThemeFilesCopyPayload returns

Anchor to copiedThemeFilescopiedThemeFiles •[OnlineStoreThemeFileOperationResult!]: The resulting theme files.

Show fields
Anchor to userErrorsuserErrors •[OnlineStoreThemeFilesUserErrors!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

Copy the content of a file into another file

Query

mutation themeFilesCopy($files: [ThemeFilesCopyFileInput!]!, $themeId: ID!) {
  themeFilesCopy(files: $files, themeId: $themeId) {
    copiedThemeFiles {
      filename
    }
    userErrors {
      field
      message
    }
  }
}

Variables

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

cURL

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

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation themeFilesCopy($files: [ThemeFilesCopyFileInput!]!, $themeId: ID!) {
    themeFilesCopy(files: $files, themeId: $themeId) {
      copiedThemeFiles {
        filename
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "themeId": "gid://shopify/OnlineStoreTheme/529529152",
        "files": [
            {
                "dstFilename": "templates/index.alt.json",
                "srcFilename": "templates/index.json"
            }
        ]
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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

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

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

Node.js

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

Shopify CLI

shopify app execute \
--query \
'mutation themeFilesCopy($files: [ThemeFilesCopyFileInput!]!, $themeId: ID!) {
  themeFilesCopy(files: $files, themeId: $themeId) {
    copiedThemeFiles {
      filename
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "themeId": "gid://shopify/OnlineStoreTheme/529529152",
  "files": [
    {
      "dstFilename": "templates/index.alt.json",
      "srcFilename": "templates/index.json"
    }
  ]
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation themeFilesCopy($files: [ThemeFilesCopyFileInput!]!, $themeId: ID!) {
        themeFilesCopy(files: $files, themeId: $themeId) {
          copiedThemeFiles {
            filename
          }
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "themeId": "gid://shopify/OnlineStoreTheme/529529152",
        "files": [
            {
                "dstFilename": "templates/index.alt.json",
                "srcFilename": "templates/index.json"
            }
        ]
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "themeFilesCopy": {
    "copiedThemeFiles": [
      {
        "filename": "templates/index.alt.json"
      }
    ],
    "userErrors": []
  }
}

Creates or updates an asset for a theme

Query

mutation ThemeFilesCopy($files: [ThemeFilesCopyFileInput!]!, $themeId: ID!) {
  themeFilesCopy(files: $files, themeId: $themeId) {
    copiedThemeFiles {
      filename
    }
    userErrors {
      code
      field
      filename
      message
    }
  }
}

Variables

{
  "themeId": "gid://shopify/OnlineStoreTheme/529529152",
  "files": [
    {
      "dstFilename": "templates/index.alt.liquid",
      "srcFilename": "templates/index.liquid"
    }
  ]
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation ThemeFilesCopy($files: [ThemeFilesCopyFileInput!]!, $themeId: ID!) { themeFilesCopy(files: $files, themeId: $themeId) { copiedThemeFiles { filename } userErrors { code field filename message } } }",
 "variables": {
    "themeId": "gid://shopify/OnlineStoreTheme/529529152",
    "files": [
      {
        "dstFilename": "templates/index.alt.liquid",
        "srcFilename": "templates/index.liquid"
      }
    ]
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation ThemeFilesCopy($files: [ThemeFilesCopyFileInput!]!, $themeId: ID!) {
    themeFilesCopy(files: $files, themeId: $themeId) {
      copiedThemeFiles {
        filename
      }
      userErrors {
        code
        field
        filename
        message
      }
    }
  }`,
  {
    variables: {
        "themeId": "gid://shopify/OnlineStoreTheme/529529152",
        "files": [
            {
                "dstFilename": "templates/index.alt.liquid",
                "srcFilename": "templates/index.liquid"
            }
        ]
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 ThemeFilesCopy($files: [ThemeFilesCopyFileInput!]!, $themeId: ID!) {
    themeFilesCopy(files: $files, themeId: $themeId) {
      copiedThemeFiles {
        filename
      }
      userErrors {
        code
        field
        filename
        message
      }
    }
  }
QUERY

variables = {
  "themeId": "gid://shopify/OnlineStoreTheme/529529152",
  "files": [
    {
      "dstFilename": "templates/index.alt.liquid",
      "srcFilename": "templates/index.liquid"
    }
  ]
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation ThemeFilesCopy($files: [ThemeFilesCopyFileInput!]!, $themeId: ID!) {
      themeFilesCopy(files: $files, themeId: $themeId) {
        copiedThemeFiles {
          filename
        }
        userErrors {
          code
          field
          filename
          message
        }
      }
    }`,
    "variables": {
        "themeId": "gid://shopify/OnlineStoreTheme/529529152",
        "files": [
            {
                "dstFilename": "templates/index.alt.liquid",
                "srcFilename": "templates/index.liquid"
            }
        ]
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation ThemeFilesCopy($files: [ThemeFilesCopyFileInput!]!, $themeId: ID!) {
  themeFilesCopy(files: $files, themeId: $themeId) {
    copiedThemeFiles {
      filename
    }
    userErrors {
      code
      field
      filename
      message
    }
  }
}' \
--variables \
'{
  "themeId": "gid://shopify/OnlineStoreTheme/529529152",
  "files": [
    {
      "dstFilename": "templates/index.alt.liquid",
      "srcFilename": "templates/index.liquid"
    }
  ]
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation ThemeFilesCopy($files: [ThemeFilesCopyFileInput!]!, $themeId: ID!) {
        themeFilesCopy(files: $files, themeId: $themeId) {
          copiedThemeFiles {
            filename
          }
          userErrors {
            code
            field
            filename
            message
          }
        }
      }
    `,
    variables: {
        "themeId": "gid://shopify/OnlineStoreTheme/529529152",
        "files": [
            {
                "dstFilename": "templates/index.alt.liquid",
                "srcFilename": "templates/index.liquid"
            }
        ]
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "themeFilesCopy": {
    "copiedThemeFiles": [
      {
        "filename": "templates/index.alt.liquid"
      }
    ],
    "userErrors": []
  }
}

themeFilesCopy reference

Examples

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

mutation themeFilesCopy($files: [ThemeFilesCopyFileInput!]!, $themeId: ID!) {

themeFilesCopy(files: $files, themeId: $themeId) {

copiedThemeFiles {

filename

}

userErrors {

field

message

}

}`,

{

variables: {

"themeId": "gid://shopify/OnlineStoreTheme/529529152",

"files": [

{

"dstFilename": "templates/index.alt.json",

"srcFilename": "templates/index.json"

}

]

);

const json = await response.json();

return json.data;

}

GQL

mutation themeFilesCopy($files: [ThemeFilesCopyFileInput!]!, $themeId: ID!) {
  themeFilesCopy(files: $files, themeId: $themeId) {
    copiedThemeFiles {
      filename
    }
    userErrors {
      field
      message
    }
  }
}

cURL

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

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation themeFilesCopy($files: [ThemeFilesCopyFileInput!]!, $themeId: ID!) {
    themeFilesCopy(files: $files, themeId: $themeId) {
      copiedThemeFiles {
        filename
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "themeId": "gid://shopify/OnlineStoreTheme/529529152",
        "files": [
            {
                "dstFilename": "templates/index.alt.json",
                "srcFilename": "templates/index.json"
            }
        ]
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

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

Ruby

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

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

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

Shopify CLI

shopify app execute \
--query \
'mutation themeFilesCopy($files: [ThemeFilesCopyFileInput!]!, $themeId: ID!) {
  themeFilesCopy(files: $files, themeId: $themeId) {
    copiedThemeFiles {
      filename
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "themeId": "gid://shopify/OnlineStoreTheme/529529152",
  "files": [
    {
      "dstFilename": "templates/index.alt.json",
      "srcFilename": "templates/index.json"
    }
  ]
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation themeFilesCopy($files: [ThemeFilesCopyFileInput!]!, $themeId: ID!) {
        themeFilesCopy(files: $files, themeId: $themeId) {
          copiedThemeFiles {
            filename
          }
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "themeId": "gid://shopify/OnlineStoreTheme/529529152",
        "files": [
            {
                "dstFilename": "templates/index.alt.json",
                "srcFilename": "templates/index.json"
            }
        ]
    },
  }),
});

const { data } = await response.json();
console.log(data);

Input variables

JSON

{

"themeId": "gid://shopify/OnlineStoreTheme/529529152",

"files": [

{

"dstFilename": "templates/index.alt.json",

"srcFilename": "templates/index.json"

}

]

}

Response

JSON

{

"themeFilesCopy": {

"copiedThemeFiles": [

{

"filename": "templates/index.alt.json"

}

"userErrors": []

}