collectionSavedSearches

query

Requires read_products access scope.

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

SavedSearchConnection arguments

•SavedSearchConnection!

Anchor to afterafter • String: The elements that come after the specified cursor.
Anchor to beforebefore • String: The elements that come before the specified cursor.
Anchor to firstfirst • Int: The first n elements from the paginated list.
Anchor to lastlast • Int: The last n elements from the paginated list.
Anchor to reversereverse • BooleanDefault:false: Reverse the order of the underlying list.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges • [SavedSearchEdge!]!non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes • [SavedSearch!]!non-null: 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.
Anchor to pageInfopageInfo • PageInfo!non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

Retrieve the first three saved collection searches

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query {
6    collectionSavedSearches(first: 3) {
7      nodes {
8        id
9        legacyResourceId
10        name
11        filters {
12          key
13          value
14        }
15        query
16        searchTerms
17      }
18    }
19  }`,
20);
21
22const data = await response.json();
23

query {
  collectionSavedSearches(first: 3) {
    nodes {
      id
      legacyResourceId
      name
      filters {
        key
        value
      }
      query
      searchTerms
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { collectionSavedSearches(first: 3) { nodes { id legacyResourceId name filters { key value } query searchTerms } } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query {
    collectionSavedSearches(first: 3) {
      nodes {
        id
        legacyResourceId
        name
        filters {
          key
          value
        }
        query
        searchTerms
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    collectionSavedSearches(first: 3) {
      nodes {
        id
        legacyResourceId
        name
        filters {
          key
          value
        }
        query
        searchTerms
      }
    }
  }`,
});

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 {
    collectionSavedSearches(first: 3) {
      nodes {
        id
        legacyResourceId
        name
        filters {
          key
          value
        }
        query
        searchTerms
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

1{
2  "collectionSavedSearches": {
3    "nodes": [
4      {
5        "id": "gid://shopify/SavedSearch/1068136130",
6        "legacyResourceId": "1068136130",
7        "name": "Smart collections",
8        "filters": [
9          {
10            "key": "collection_type",
11            "value": "smart"
12          }
13        ],
14        "query": "collection_type:\"smart\"",
15        "searchTerms": ""
16      },
17      {
18        "id": "gid://shopify/SavedSearch/1068136131",
19        "legacyResourceId": "1068136131",
20        "name": "Not published on the Online store",
21        "filters": [
22          {
23            "key": "published_status",
24            "value": "online_store:hidden"
25          }
26        ],
27        "query": "published_status:\"online_store:hidden\"",
28        "searchTerms": ""
29      },
30      {
31        "id": "gid://shopify/SavedSearch/1068136132",
32        "legacyResourceId": "1068136132",
33        "name": "Published on Facebook",
34        "filters": [
35          {
36            "key": "published_status",
37            "value": "facebook-ads:visible"
38          }
39        ],
40        "query": "published_status:\"facebook-ads:visible\"",
41        "searchTerms": ""
42      }
43    ]
44  }
45}