themes

Returns a paginated list of OnlineStoreTheme objects for the online store. Themes control the appearance and layout of the storefront.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the themes action (under Themes).
Fill in the fields below, then reference the result from later steps as {{themes.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query Themes($roles: [ThemeRole!], $names: [String!], $first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean) {
  themes(
    roles: $roles
    names: $names
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
  ) {
    edges {
      cursor
      node {
        createdAt
        id
        name
        prefix
        processing
        processingFailed
        role
        themeStoreId
        updatedAt
      }
    }
    nodes {
      createdAt
      id
      name
      prefix
      processing
      processingFailed
      role
      themeStoreId
      updatedAt
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

rolesarray<string>

The theme roles to filter by.

namesarray<string>

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

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

json

{
  "roles": [
    "MAIN"
  ],
  "names": [
    "string"
  ],
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false
}

Response

Read the result with {{themes.response.data.data.themes}}. If the API returns errors, the step fails and they are at {{themes.response.data.errors}}.

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

createdAtobject

idobject

nameobject

prefixobject

processingobject

processingFailedobject

roleobject

themeStoreIdobject

updatedAtobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?