Choose a version:

OnlineStoreTheme

object

Requires read_themes access scope.

A theme for display on the storefront. Themes control the visual appearance and functionality of the online store through templates, stylesheets, and assets that determine how products, collections, and other content display to customers.

Each theme has a role that indicates its status. Main themes are live on the storefront, unpublished themes are inactive, demo themes require purchase before publishing, and development themes are temporary for previewing during development. The theme includes translations for multi-language support.

Anchor to FieldsFields

Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the theme was created.
Anchor to filesfiles •OnlineStoreThemeFileConnection: The files in the theme.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to namename •String! non-null: The name of the theme, set by the merchant.
Anchor to prefixprefix •String! non-null: The prefix of the theme.
Anchor to processingprocessing •Boolean! non-null: Whether the theme is processing.
Anchor to processingFailedprocessingFailed •Boolean! non-null: Whether the theme processing failed.
Anchor to rolerole •ThemeRole! non-null: The role of the theme.
Anchor to themeStoreIdthemeStoreId •Int: The theme store ID.
Anchor to translationstranslations •[Translation!]! non-null: The published translations associated with the resource.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the theme was last updated.

Was this section helpful?

Anchor to QueriesQueries

Anchor to theme theme •query: Returns an OnlineStoreTheme by its ID. Use this query to retrieve theme metadata and access the theme's files, which include templates, assets, translations, and configuration files.
Anchor to themes themes •query: Returns a paginated list of OnlineStoreTheme objects for the online store. Themes control the appearance and layout of the storefront.

You can filter themes by role to find specific theme types, such as MAIN for the published theme and UNPUBLISHED for draft themes.

Was this section helpful?

Anchor to MutationsMutations

Anchor to themeCreate themeCreate •mutation: Creates a theme using an external URL or for files that were previously uploaded using the stagedUploadsCreate mutation. These themes are added to the Themes page in Shopify admin.
Anchor to themeDuplicate themeDuplicate •mutation: Duplicates a theme.
Anchor to themePublish themePublish •mutation: Publishes a theme.
Anchor to themeUpdate themeUpdate •mutation: Updates a theme.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to HasPublishedTranslations HasPublishedTranslations •interface
Anchor to Node Node •interface

Was this section helpful?