scriptTags - admin-graphql - QUERY

Version: 2024-10

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 list of script tags.

Access Scopes

Arguments

• after: String - The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
• before: String - The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
• first: Int - The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
• last: Int - The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
• query: String - A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | created_at | time | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | src | string | | updated_at | time | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).
• reverse: Boolean - Reverse the order of the underlying list.
• src: URL - The source URL of the script tag to filter by.

Returns

• edges: ScriptTagEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
• nodes: ScriptTag! A list of nodes that are contained in ScriptTagEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
• pageInfo: PageInfo! An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page.

Examples

• Get the first five script tags

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { scriptTags(first: 5) { edges { node { id } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    scriptTags(first: 5) {\n      edges {\n        node {\n          id\n        }\n      }\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 {\n    scriptTags(first: 5) {\n      edges {\n        node {\n          id\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    scriptTags(first: 5) {\n      edges {\n        node {\n          id\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    scriptTags(first: 5) {\n      edges {\n        node {\n          id\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  scriptTags(first: 5) {\n    edges {\n      node {\n        id\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "scriptTags": {
        "edges": [
          {
            "node": {
              "id": "gid://shopify/ScriptTag/193372190"
            }
          },
          {
            "node": {
              "id": "gid://shopify/ScriptTag/408148298"
            }
          },
          {
            "node": {
              "id": "gid://shopify/ScriptTag/466217408"
            }
          },
          {
            "node": {
              "id": "gid://shopify/ScriptTag/558170166"
            }
          },
          {
            "node": {
              "id": "gid://shopify/ScriptTag/764371933"
            }
          }
        ]
      }
    }
  }

  Get the first script tag with a specific source URL

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { scriptTags(first: 1, src: \\\"https://js.example.org/foo.js\\\") { edges { node { id } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    scriptTags(first: 1, src: \"https://js.example.org/foo.js\") {\n      edges {\n        node {\n          id\n        }\n      }\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 {\n    scriptTags(first: 1, src: \"https://js.example.org/foo.js\") {\n      edges {\n        node {\n          id\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    scriptTags(first: 1, src: \"https://js.example.org/foo.js\") {\n      edges {\n        node {\n          id\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    scriptTags(first: 1, src: \"https://js.example.org/foo.js\") {\n      edges {\n        node {\n          id\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  scriptTags(first: 1, src: \"https://js.example.org/foo.js\") {\n    edges {\n      node {\n        id\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "scriptTags": {
        "edges": [
          {
            "node": {
              "id": "gid://shopify/ScriptTag/466217408"
            }
          }
        ]
      }
    }
  }

  Retrieves a list of all script tags

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query GetScriptTags($first: Int!, $cursor: String) { scriptTags(first: $first, after: $cursor) { nodes { id cache createdAt displayScope src updatedAt } pageInfo { startCursor endCursor } } }\",\n \"variables\": {\n    \"first\": 5,\n    \"cursor\": null\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query GetScriptTags($first: Int!, $cursor: String) {\n      scriptTags(first: $first, after: $cursor) {\n        nodes {\n          id\n          cache\n          createdAt\n          displayScope\n          src\n          updatedAt\n        }\n        pageInfo {\n          startCursor\n          endCursor\n        }\n      }\n    }`,\n    \"variables\": {\n      \"first\": 5,\n      \"cursor\": null\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 GetScriptTags($first: Int!, $cursor: String) {\n    scriptTags(first: $first, after: $cursor) {\n      nodes {\n        id\n        cache\n        createdAt\n        displayScope\n        src\n        updatedAt\n      }\n      pageInfo {\n        startCursor\n        endCursor\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"first\": 5,\n  \"cursor\": nil\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 GetScriptTags($first: Int!, $cursor: String) {\n    scriptTags(first: $first, after: $cursor) {\n      nodes {\n        id\n        cache\n        createdAt\n        displayScope\n        src\n        updatedAt\n      }\n      pageInfo {\n        startCursor\n        endCursor\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"first\" => 5,\n  \"cursor\" => null,\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 GetScriptTags($first: Int!, $cursor: String) {\n    scriptTags(first: $first, after: $cursor) {\n      nodes {\n        id\n        cache\n        createdAt\n        displayScope\n        src\n        updatedAt\n      }\n      pageInfo {\n        startCursor\n        endCursor\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"first\": 5,\n      \"cursor\": null\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query GetScriptTags($first: Int!, $cursor: String) {\n  scriptTags(first: $first, after: $cursor) {\n    nodes {\n      id\n      cache\n      createdAt\n      displayScope\n      src\n      updatedAt\n    }\n    pageInfo {\n      startCursor\n      endCursor\n    }\n  }\n}"
        

  input: {
    "first": 5,
    "cursor": null
  }

  response: {
    "data": {
      "scriptTags": {
        "nodes": [
          {
            "id": "gid://shopify/ScriptTag/193372190",
            "cache": false,
            "createdAt": "2024-10-29T22:38:08Z",
            "displayScope": "ONLINE_STORE",
            "src": "https://js.example.org/online_store.js",
            "updatedAt": "2024-10-29T22:38:08Z"
          },
          {
            "id": "gid://shopify/ScriptTag/408148298",
            "cache": false,
            "createdAt": "2024-10-29T22:38:08Z",
            "displayScope": "ALL",
            "src": "https://protocol-relative.com/foo.js",
            "updatedAt": "2024-10-29T22:38:08Z"
          },
          {
            "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"
          },
          {
            "id": "gid://shopify/ScriptTag/558170166",
            "cache": false,
            "createdAt": "2024-10-29T22:38:08Z",
            "displayScope": "ALL",
            "src": "https://js.example.org/bar.js?bar=baz",
            "updatedAt": "2024-10-29T22:38:08Z"
          },
          {
            "id": "gid://shopify/ScriptTag/764371933",
            "cache": false,
            "createdAt": "2024-10-29T22:38:08Z",
            "displayScope": "ALL",
            "src": "https://secure-js.example.org/bar.js?bar=baz",
            "updatedAt": "2024-10-29T22:38:08Z"
          }
        ],
        "pageInfo": {
          "startCursor": "eyJsYXN0X2lkIjoxOTMzNzIxOTAsImxhc3RfdmFsdWUiOiIxOTMzNzIxOTAifQ==",
          "endCursor": "eyJsYXN0X2lkIjo3NjQzNzE5MzMsImxhc3RfdmFsdWUiOiI3NjQzNzE5MzMifQ=="
        }
      }
    }
  }