Choose a version:

scriptTag

query

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.

Lookup a script tag resource by ID.

Arguments

Anchor to idid •ID! required: The ID of the ScriptTag to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to ScriptTagScriptTag •ScriptTag: 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.

A script tag represents remote JavaScript code that is loaded into the pages of a shop's storefront or the Order status page of checkout.

Was this section helpful?

Examples

Retrieves a single script tag

Query

query GetScriptTag($id: ID!) {
  scriptTag(id: $id) {
    id
    cache
    createdAt
    displayScope
    src
    updatedAt
  }
}

Variables

{
  "id": "gid://shopify/ScriptTag/466217408"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query GetScriptTag($id: ID!) { scriptTag(id: $id) { id cache createdAt displayScope src updatedAt } }",
 "variables": {
    "id": "gid://shopify/ScriptTag/466217408"
  }
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  query GetScriptTag($id: ID!) {
    scriptTag(id: $id) {
      id
      cache
      createdAt
      displayScope
      src
      updatedAt
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/ScriptTag/466217408"
    },
  },
);

const data = await response.json();

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
  query GetScriptTag($id: ID!) {
    scriptTag(id: $id) {
      id
      cache
      createdAt
      displayScope
      src
      updatedAt
    }
  }
QUERY

variables = {
  "id": "gid://shopify/ScriptTag/466217408"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query GetScriptTag($id: ID!) {
      scriptTag(id: $id) {
        id
        cache
        createdAt
        displayScope
        src
        updatedAt
      }
    }`,
    "variables": {
      "id": "gid://shopify/ScriptTag/466217408"
    },
  },
});

Response

{
  "scriptTag": {
    "id": "gid://shopify/ScriptTag/466217408",
    "cache": false,
    "createdAt": "2024-10-29T22:38:08Z",
    "displayScope": "ALL",
    "src": "https://js.example.org/foo.js",
    "updatedAt": "2024-10-29T22:38:08Z"
  }
}

Retrieves a single script tag

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query GetScriptTag($id: ID!) {

scriptTag(id: $id) {

cache

createdAt

displayScope

src

updatedAt

}

}`,

{

variables: {

"id": "gid://shopify/ScriptTag/466217408"

);

const data = await response.json();

query GetScriptTag($id: ID!) {
  scriptTag(id: $id) {
    id
    cache
    createdAt
    displayScope
    src
    updatedAt
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query GetScriptTag($id: ID!) { scriptTag(id: $id) { id cache createdAt displayScope src updatedAt } }",
 "variables": {
    "id": "gid://shopify/ScriptTag/466217408"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  query GetScriptTag($id: ID!) {
    scriptTag(id: $id) {
      id
      cache
      createdAt
      displayScope
      src
      updatedAt
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/ScriptTag/466217408"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query GetScriptTag($id: ID!) {
      scriptTag(id: $id) {
        id
        cache
        createdAt
        displayScope
        src
        updatedAt
      }
    }`,
    "variables": {
      "id": "gid://shopify/ScriptTag/466217408"
    },
  },
});

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
  query GetScriptTag($id: ID!) {
    scriptTag(id: $id) {
      id
      cache
      createdAt
      displayScope
      src
      updatedAt
    }
  }
QUERY

variables = {
  "id": "gid://shopify/ScriptTag/466217408"
}

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

Input variables

JSON

{

"id": "gid://shopify/ScriptTag/466217408"

}

Response

JSON

{

"scriptTag": {

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

"cache": false,

"createdAt": "2024-10-29T22:38:08Z",

"displayScope": "ALL",

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

"updatedAt": "2024-10-29T22:38:08Z"

}