ScriptTag - admin-graphql - OBJECT

Version: 2025-01

Description:

<div class="note"><h4>Theme app extensions</h4> <p>Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. <a href="/apps/online-store#what-integration-method-should-i-use" target="_blank">Learn more</a>.</p></div> <div class="note"><h4>Script tag deprecation</h4> <p>Script tags will be sunset for the <b>Order status</b> page on August 28, 2025. <a href="https://www.shopify.com/plus/upgrading-to-checkout-extensibility">Upgrade to Checkout Extensibility</a> before this date. <a href="/docs/api/liquid/objects#script">Shopify Scripts</a> will continue to work alongside Checkout Extensibility until August 28, 2025.</p></div> 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.

Access Scopes

`read_script_tags` access scope.

Fields

• cache: Boolean! - Whether the Shopify CDN can cache and serve the script tag. If `true`, then the script will be cached and served by the CDN. The cache expires 15 minutes after the script tag is successfully returned. If `false`, then the script will be served as is.
• createdAt: DateTime! - The date and time when the script tag was created.
• displayScope: ScriptTagDisplayScope! - The page or pages on the online store that the script should be included.
• id: ID! - A globally-unique ID.
• legacyResourceId: UnsignedInt64! - The ID of the corresponding resource in the REST Admin API.
• src: URL! - The URL to the remote script.
• updatedAt: DateTime! - The date and time when the script tag was last updated.

Connections

Related queries

• scriptTag <div class="note"><h4>Theme app extensions</h4> <p>Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. <a href="/apps/online-store#what-integration-method-should-i-use" target="_blank">Learn more</a>.</p></div> <div class="note"><h4>Script tag deprecation</h4> <p>Script tags will be sunset for the <b>Order status</b> page on August 28, 2025. <a href="https://www.shopify.com/plus/upgrading-to-checkout-extensibility">Upgrade to Checkout Extensibility</a> before this date. <a href="/docs/api/liquid/objects#script">Shopify Scripts</a> will continue to work alongside Checkout Extensibility until August 28, 2025.</p></div> Lookup a script tag resource by ID.
• scriptTags <div class="note"><h4>Theme app extensions</h4> <p>Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. <a href="/apps/online-store#what-integration-method-should-i-use" target="_blank">Learn more</a>.</p></div> <div class="note"><h4>Script tag deprecation</h4> <p>Script tags will be sunset for the <b>Order status</b> page on August 28, 2025. <a href="https://www.shopify.com/plus/upgrading-to-checkout-extensibility">Upgrade to Checkout Extensibility</a> before this date. <a href="/docs/api/liquid/objects#script">Shopify Scripts</a> will continue to work alongside Checkout Extensibility until August 28, 2025.</p></div> A list of script tags.

Related mutations

• scriptTagCreate <div class="note"><h4>Theme app extensions</h4> <p>Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. <a href="/apps/online-store#what-integration-method-should-i-use" target="_blank">Learn more</a>.</p></div> <div class="note"><h4>Script tag deprecation</h4> <p>Script tags will be sunset for the <b>Order status</b> page on August 28, 2025. <a href="https://www.shopify.com/plus/upgrading-to-checkout-extensibility">Upgrade to Checkout Extensibility</a> before this date. <a href="/docs/api/liquid/objects#script">Shopify Scripts</a> will continue to work alongside Checkout Extensibility until August 28, 2025.</p></div> Creates a new script tag.
• scriptTagUpdate <div class="note"><h4>Theme app extensions</h4> <p>Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. <a href="/apps/online-store#what-integration-method-should-i-use" target="_blank">Learn more</a>.</p></div> <div class="note"><h4>Script tag deprecation</h4> <p>Script tags will be sunset for the <b>Order status</b> page on August 28, 2025. <a href="https://www.shopify.com/plus/upgrading-to-checkout-extensibility">Upgrade to Checkout Extensibility</a> before this date. <a href="/docs/api/liquid/objects#script">Shopify Scripts</a> will continue to work alongside Checkout Extensibility until August 28, 2025.</p></div> Updates a script tag.

Related Unions

Examples

• Retrieves a single script tag

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query GetScriptTag($id: ID!) { scriptTag(id: $id) { id cache createdAt displayScope src updatedAt } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/ScriptTag/466217408\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query GetScriptTag($id: ID!) {\n      scriptTag(id: $id) {\n        id\n        cache\n        createdAt\n        displayScope\n        src\n        updatedAt\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/ScriptTag/466217408\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query GetScriptTag($id: ID!) {\n    scriptTag(id: $id) {\n      id\n      cache\n      createdAt\n      displayScope\n      src\n      updatedAt\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/ScriptTag/466217408\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query GetScriptTag($id: ID!) {\n    scriptTag(id: $id) {\n      id\n      cache\n      createdAt\n      displayScope\n      src\n      updatedAt\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/ScriptTag/466217408\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query GetScriptTag($id: ID!) {\n    scriptTag(id: $id) {\n      id\n      cache\n      createdAt\n      displayScope\n      src\n      updatedAt\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/ScriptTag/466217408\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query GetScriptTag($id: ID!) {\n  scriptTag(id: $id) {\n    id\n    cache\n    createdAt\n    displayScope\n    src\n    updatedAt\n  }\n}"
        

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

  response: {
    "data": {
      "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"
      }
    }
  }