collectionSavedSearches - admin-graphql - QUERY

Version: 2024-07

Description:

Returns a list of the shop's collection saved searches.

Access Scopes

`read_products` access scope.

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).
• reverse: Boolean - Reverse the order of the underlying list.

Returns

• edges: SavedSearchEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
• nodes: SavedSearch! A list of nodes that are contained in SavedSearchEdge. 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

• Retrieve the first three saved collection searches

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { collectionSavedSearches(first: 3) { nodes { id legacyResourceId name filters { key value } query searchTerms } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    collectionSavedSearches(first: 3) {\n      nodes {\n        id\n        legacyResourceId\n        name\n        filters {\n          key\n          value\n        }\n        query\n        searchTerms\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    collectionSavedSearches(first: 3) {\n      nodes {\n        id\n        legacyResourceId\n        name\n        filters {\n          key\n          value\n        }\n        query\n        searchTerms\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    collectionSavedSearches(first: 3) {\n      nodes {\n        id\n        legacyResourceId\n        name\n        filters {\n          key\n          value\n        }\n        query\n        searchTerms\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    collectionSavedSearches(first: 3) {\n      nodes {\n        id\n        legacyResourceId\n        name\n        filters {\n          key\n          value\n        }\n        query\n        searchTerms\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  collectionSavedSearches(first: 3) {\n    nodes {\n      id\n      legacyResourceId\n      name\n      filters {\n        key\n        value\n      }\n      query\n      searchTerms\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "collectionSavedSearches": {
        "nodes": [
          {
            "id": "gid://shopify/SavedSearch/1068136130",
            "legacyResourceId": "1068136130",
            "name": "Smart collections",
            "filters": [
              {
                "key": "collection_type",
                "value": "smart"
              }
            ],
            "query": "collection_type:\"smart\"",
            "searchTerms": ""
          },
          {
            "id": "gid://shopify/SavedSearch/1068136131",
            "legacyResourceId": "1068136131",
            "name": "Not published on the Online store",
            "filters": [
              {
                "key": "published_status",
                "value": "online_store:hidden"
              }
            ],
            "query": "published_status:\"online_store:hidden\"",
            "searchTerms": ""
          },
          {
            "id": "gid://shopify/SavedSearch/1068136132",
            "legacyResourceId": "1068136132",
            "name": "Published on Facebook",
            "filters": [
              {
                "key": "published_status",
                "value": "facebook-ads:visible"
              }
            ],
            "query": "published_status:\"facebook-ads:visible\"",
            "searchTerms": ""
          }
        ]
      }
    }
  }