Choose a version:

themeCreate

mutation

Requires The user needs write_themes and an exemption from Shopify to modify themes. If you think that your app is eligible for an exemption and should have access to this API, then you can submit an exception request.

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.

Anchor to Arguments

Arguments

Anchor to namename

•String

The name of the theme to be created.

Anchor to rolerole

•ThemeRole

Default:UNPUBLISHED

The role of the theme to be created. Only UNPUBLISHED and DEVELOPMENT roles are permitted.

Anchor to sourcesource

•URL!

required

An external URL or a staged upload URL of the theme to import.

Was this section helpful?

Anchor to ThemeCreatePayload returnsThemeCreatePayload returns

Anchor to themetheme •OnlineStoreTheme: The theme that was created.
Anchor to userErrorsuserErrors •[ThemeCreateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Create a new theme from an url with a custom name

Query

mutation themeCreate($source: URL!, $name: String!) {
  themeCreate(source: $source, name: $name) {
    theme {
      name
      role
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "source": "http://www.example.com/dawn.zip",
  "name": "Dawn"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation themeCreate($source: URL!, $name: String!) { themeCreate(source: $source, name: $name) { theme { name role } userErrors { field message } } }",
 "variables": {
    "source": "http://www.example.com/dawn.zip",
    "name": "Dawn"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation themeCreate($source: URL!, $name: String!) {
    themeCreate(source: $source, name: $name) {
      theme {
        name
        role
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "source": "http://www.example.com/dawn.zip",
        "name": "Dawn"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 themeCreate($source: URL!, $name: String!) {
    themeCreate(source: $source, name: $name) {
      theme {
        name
        role
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "source": "http://www.example.com/dawn.zip",
  "name": "Dawn"
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation themeCreate($source: URL!, $name: String!) {
      themeCreate(source: $source, name: $name) {
        theme {
          name
          role
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "source": "http://www.example.com/dawn.zip",
        "name": "Dawn"
    },
  },
});

Response

{
  "themeCreate": {
    "theme": {
      "name": "Dawn",
      "role": "UNPUBLISHED"
    },
    "userErrors": []
  }
}

Creates a theme

Query

mutation ThemeCreate($name: String, $source: URL!) {
  themeCreate(name: $name, source: $source) {
    theme {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "name": "New Theme",
  "source": "http://someurl.com/lemongrass.zip"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation ThemeCreate($name: String, $source: URL!) { themeCreate(name: $name, source: $source) { theme { id } userErrors { code field message } } }",
 "variables": {
    "name": "New Theme",
    "source": "http://someurl.com/lemongrass.zip"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation ThemeCreate($name: String, $source: URL!) {
    themeCreate(name: $name, source: $source) {
      theme {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
        "name": "New Theme",
        "source": "http://someurl.com/lemongrass.zip"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 ThemeCreate($name: String, $source: URL!) {
    themeCreate(name: $name, source: $source) {
      theme {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "name": "New Theme",
  "source": "http://someurl.com/lemongrass.zip"
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation ThemeCreate($name: String, $source: URL!) {
      themeCreate(name: $name, source: $source) {
        theme {
          id
        }
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
        "name": "New Theme",
        "source": "http://someurl.com/lemongrass.zip"
    },
  },
});

Response

{
  "themeCreate": {
    "theme": {
      "id": "gid://shopify/OnlineStoreTheme/1049083724"
    },
    "userErrors": []
  }
}

themeCreate reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation themeCreate($source: URL!, $name: String!) {

themeCreate(source: $source, name: $name) {

theme {

name

role

}

userErrors {

field

message

}

}`,

{

variables: {

"source": "http://www.example.com/dawn.zip",

"name": "Dawn"

);

const json = await response.json();

return json.data;

}

GQL

mutation themeCreate($source: URL!, $name: String!) {
  themeCreate(source: $source, name: $name) {
    theme {
      name
      role
    }
    userErrors {
      field
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation themeCreate($source: URL!, $name: String!) { themeCreate(source: $source, name: $name) { theme { name role } userErrors { field message } } }",
 "variables": {
    "source": "http://www.example.com/dawn.zip",
    "name": "Dawn"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation themeCreate($source: URL!, $name: String!) {
    themeCreate(source: $source, name: $name) {
      theme {
        name
        role
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "source": "http://www.example.com/dawn.zip",
        "name": "Dawn"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation themeCreate($source: URL!, $name: String!) {
      themeCreate(source: $source, name: $name) {
        theme {
          name
          role
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "source": "http://www.example.com/dawn.zip",
        "name": "Dawn"
    },
  },
});

Ruby

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 themeCreate($source: URL!, $name: String!) {
    themeCreate(source: $source, name: $name) {
      theme {
        name
        role
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "source": "http://www.example.com/dawn.zip",
  "name": "Dawn"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"source": "http://www.example.com/dawn.zip",

"name": "Dawn"

}

Response

JSON

{

"themeCreate": {

"theme": {

"name": "Dawn",

"role": "UNPUBLISHED"

"userErrors": []

}