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 filenamesfilenames •[String!]: The filenames of the theme files. At most 50 filenames can be specified. Use '*' to match zero or more characters.
Anchor to firstfirst •Int Default:50: Returns at most the first n files for this theme. Fewer than n files may be returned to stay within the payload size limit, or when the end of the list is reached. At most 2500 can be fetched at once.
Anchor to afterafter •String: A cursor for use in pagination.

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 localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

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 idid •ID! required: The ID of the theme.

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.

Arguments

Anchor to rolesroles

•[ThemeRole!]

The theme roles to filter by.

Anchor to namesnames

•[String!]

The theme names to filter by. Use '*' to match zero or more characters.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Was this section helpful?

Anchor to MutationsMutations

Anchor to themeCreate themeCreate

•mutation

Creates a theme from an external URL or staged upload. The theme source can either be a ZIP file hosted at a public URL or files previously uploaded using the stagedUploadsCreate mutation. The theme displays in the Themes page in the Shopify admin.

New themes have an UNPUBLISHED role by default. You can optionally specify a DEVELOPMENT role for temporary themes used during development.