Theme File

Read and write a theme's files, file version history, and custom templates

Theme files are the layouts, templates, sections, snippets, assets, configs, and locale files that make up a theme. Reading and writing files corresponds to the code editor in the admin; these endpoints work on a theme directly and do not need an edit session.

Provides endpoints to browse a theme's file tree, create, read, update, rename, and delete files, inspect file version history, and manage custom templates bound to products, collections, and pages.

📄️Get theme file tree

Get the file tree of the specified theme.

📄️Get theme file

Retrieve details of a specific theme's doc file using its unique identifier

📄️Create theme file

Creates a new file within the specified theme.

📄️Delete theme file

Delete a specific theme file by theme ID, file type, and file location. `assets/theme.css` and

📄️Update theme file

Replace the whole content of the specified file. Changes to the default theme's files take

📄️Rename theme file

Renames an existing file within the specified theme.

📄️List versions of all theme files

Returns the version history for all files in the specified theme.

📄️List versions of a theme file

Returns the version history for a single theme file.

📄️Get theme file version

Retrieves a specific version of a theme file by its version ID.

📄️List theme custom templates

List the custom templates bound to products, collections, or custom pages.

📄️Create theme custom template

Create a custom template and bind it to objects (products, collections) in one call; with empty

📄️Delete theme custom template

Delete a custom template within the specified theme.

📄️Update theme custom template

Update the bindings (products, collections) of an existing template. `relations` replaces the