Choose a version:

scriptTagCreate

mutation

Requires write_script_tags access scope.

Theme app extensions

If your app integrates with a Shopify theme and you plan to submit it to the Shopify App Store, you must use theme app extensions instead of Script tags. Script tags can only be used with vintage themes. Learn more.

Script tag deprecation

Script tags will be sunset for the Order status page on August 28, 2025. Upgrade to Checkout Extensibility before this date. Shopify Scripts will continue to work alongside Checkout Extensibility until August 28, 2025.

Creates a new script tag.

Anchor to Arguments

Arguments

Anchor to inputinput

•ScriptTagInput!

required

The input fields for a script tag.

Was this section helpful?

Anchor to ScriptTagCreatePayload returnsScriptTagCreatePayload returns

Anchor to scriptTagscriptTag •ScriptTag: The script tag that was created.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Creates a new script tag

Query

mutation ScriptTagCreate($input: ScriptTagInput!) {
  scriptTagCreate(input: $input) {
    scriptTag {
      id
      cache
      createdAt
      displayScope
      src
      updatedAt
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": {
    "src": "https://js.example.org/bar.js",
    "displayScope": "ONLINE_STORE",
    "cache": true
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation ScriptTagCreate($input: ScriptTagInput!) { scriptTagCreate(input: $input) { scriptTag { id cache createdAt displayScope src updatedAt } userErrors { field message } } }",
 "variables": {
    "input": {
      "src": "https://js.example.org/bar.js",
      "displayScope": "ONLINE_STORE",
      "cache": true
    }
  }
}'

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 ScriptTagCreate($input: ScriptTagInput!) {
    scriptTagCreate(input: $input) {
      scriptTag {
        id
        cache
        createdAt
        displayScope
        src
        updatedAt
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "input": {
            "src": "https://js.example.org/bar.js",
            "displayScope": "ONLINE_STORE",
            "cache": true
        }
    },
  },
  );
  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 ScriptTagCreate($input: ScriptTagInput!) {
    scriptTagCreate(input: $input) {
      scriptTag {
        id
        cache
        createdAt
        displayScope
        src
        updatedAt
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "src": "https://js.example.org/bar.js",
    "displayScope": "ONLINE_STORE",
    "cache": true
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation ScriptTagCreate($input: ScriptTagInput!) {
      scriptTagCreate(input: $input) {
        scriptTag {
          id
          cache
          createdAt
          displayScope
          src
          updatedAt
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "input": {
            "src": "https://js.example.org/bar.js",
            "displayScope": "ONLINE_STORE",
            "cache": true
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation ScriptTagCreate($input: ScriptTagInput!) {
  scriptTagCreate(input: $input) {
    scriptTag {
      id
      cache
      createdAt
      displayScope
      src
      updatedAt
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "input": {
    "src": "https://js.example.org/bar.js",
    "displayScope": "ONLINE_STORE",
    "cache": true
  }
}'

Response

{
  "scriptTagCreate": {
    "scriptTag": {
      "id": "gid://shopify/ScriptTag/870402687",
      "cache": true,
      "createdAt": "2024-12-18T11:36:28Z",
      "displayScope": "ONLINE_STORE",
      "src": "https://js.example.org/bar.js",
      "updatedAt": "2024-12-18T11:36:28Z"
    },
    "userErrors": []
  }
}

scriptTagCreate 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 ScriptTagCreate($input: ScriptTagInput!) {

scriptTagCreate(input: $input) {

scriptTag {

cache

createdAt

displayScope

src

updatedAt

}

userErrors {

field

message

}

}`,

{

variables: {

"input": {

"src": "https://js.example.org/bar.js",

"displayScope": "ONLINE_STORE",

"cache": true

}

);

const json = await response.json();

return json.data;

}

GQL

mutation ScriptTagCreate($input: ScriptTagInput!) {
  scriptTagCreate(input: $input) {
    scriptTag {
      id
      cache
      createdAt
      displayScope
      src
      updatedAt
    }
    userErrors {
      field
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation ScriptTagCreate($input: ScriptTagInput!) { scriptTagCreate(input: $input) { scriptTag { id cache createdAt displayScope src updatedAt } userErrors { field message } } }",
 "variables": {
    "input": {
      "src": "https://js.example.org/bar.js",
      "displayScope": "ONLINE_STORE",
      "cache": true
    }
  }
}'

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 ScriptTagCreate($input: ScriptTagInput!) {
    scriptTagCreate(input: $input) {
      scriptTag {
        id
        cache
        createdAt
        displayScope
        src
        updatedAt
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "input": {
            "src": "https://js.example.org/bar.js",
            "displayScope": "ONLINE_STORE",
            "cache": true
        }
    },
  },
  );
  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 ScriptTagCreate($input: ScriptTagInput!) {
      scriptTagCreate(input: $input) {
        scriptTag {
          id
          cache
          createdAt
          displayScope
          src
          updatedAt
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "input": {
            "src": "https://js.example.org/bar.js",
            "displayScope": "ONLINE_STORE",
            "cache": true
        }
    },
  },
});

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 ScriptTagCreate($input: ScriptTagInput!) {
    scriptTagCreate(input: $input) {
      scriptTag {
        id
        cache
        createdAt
        displayScope
        src
        updatedAt
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "src": "https://js.example.org/bar.js",
    "displayScope": "ONLINE_STORE",
    "cache": true
  }
}

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

Shopify CLI

shopify app execute \
--query \
'mutation ScriptTagCreate($input: ScriptTagInput!) {
  scriptTagCreate(input: $input) {
    scriptTag {
      id
      cache
      createdAt
      displayScope
      src
      updatedAt
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "input": {
    "src": "https://js.example.org/bar.js",
    "displayScope": "ONLINE_STORE",
    "cache": true
  }
}'

Input variables

JSON

{

"input": {

"src": "https://js.example.org/bar.js",

"displayScope": "ONLINE_STORE",

"cache": true

}

Response

JSON

{

"scriptTagCreate": {

"scriptTag": {

"id": "gid://shopify/ScriptTag/870402687",

"cache": true,

"createdAt": "2024-12-18T11:36:28Z",

"displayScope": "ONLINE_STORE",

"src": "https://js.example.org/bar.js",

"updatedAt": "2024-12-18T11:36:28Z"

"userErrors": []

}