Requires The user must have write_themes and write_themes_assets.

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


The files to update.

Anchor to themeId
themeId
required

The theme to update.


Was this section helpful?

The list of errors that occurred from executing the mutation.


Was this section helpful?

Examples

Hide code
Copy
mutation themeFilesCopy($files: [ThemeFilesCopyFileInput!]!, $themeId: ID!) {
  themeFilesCopy(files: $files, themeId: $themeId) {
    copiedThemeFiles {
      filename
    }
    userErrors {
      field
      message
    }
  }
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/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"
      }
    ]
  }
}'
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 data = await response.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 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)
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"
        }
      ]
    },
  },
});
use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$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]);
Hide code
Input variables
Copy
{
  "themeId": "gid://shopify/OnlineStoreTheme/529529152",
  "files": [
    {
      "dstFilename": "templates/index.alt.json",
      "srcFilename": "templates/index.json"
    }
  ]
}
Hide code
Response
JSON
{
  "themeFilesCopy": {
    "copiedThemeFiles": [
      {
        "filename": "templates/index.alt.json"
      }
    ],
    "userErrors": []
  }
}