Choose a version:

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

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query {

collectionSavedSearches(first: 3) {

nodes {

legacyResourceId

name

filters {

key

value

}

query

searchTerms

}

}`,

);

const data = await response.json();

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/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

{

"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": ""

}

]

}