Choose a version:

productSavedSearches

query

Requires read_products access scope.

Returns a list of the shop's product 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 •Boolean Default: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?

Examples

Retrieve the first three saved product searches

Description

Retrieve the first three saved product searches. A saved search is a specific search query that you can use to quickly find products. This example returns the first three saved product searches.

Query

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

cURL

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

Remix

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

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

const data = await response.json();

Ruby

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

response = client.query(query: query)

Node.js

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

Response

{
  "productSavedSearches": {
    "nodes": [
      {
        "id": "gid://shopify/SavedSearch/136409974",
        "legacyResourceId": "136409974",
        "name": "Foo Products",
        "filters": [],
        "query": "foo",
        "searchTerms": "foo"
      },
      {
        "id": "gid://shopify/SavedSearch/1068136123",
        "legacyResourceId": "1068136123",
        "name": "Drafts",
        "filters": [
          {
            "key": "status",
            "value": "DRAFT"
          }
        ],
        "query": "status:\"DRAFT\"",
        "searchTerms": ""
      },
      {
        "id": "gid://shopify/SavedSearch/1068136124",
        "legacyResourceId": "1068136124",
        "name": "Products from Vendor X",
        "filters": [
          {
            "key": "vendor",
            "value": "Vendor X"
          }
        ],
        "query": "vendor:\"Vendor X\"",
        "searchTerms": ""
      }
    ]
  }
}

Retrieve the first three saved product searches

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query {

productSavedSearches(first: 3) {

nodes {

legacyResourceId

name

filters {

key

value

}

query

searchTerms

}

}`,

);

const data = await response.json();

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

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

const response = await admin.graphql(
  `#graphql
  query {
    productSavedSearches(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 {
    productSavedSearches(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 {
    productSavedSearches(first: 3) {
      nodes {
        id
        legacyResourceId
        name
        filters {
          key
          value
        }
        query
        searchTerms
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"productSavedSearches": {

"nodes": [

{

"id": "gid://shopify/SavedSearch/136409974",

"legacyResourceId": "136409974",

"name": "Foo Products",

"filters": [],

"query": "foo",

"searchTerms": "foo"

{

"id": "gid://shopify/SavedSearch/1068136123",

"legacyResourceId": "1068136123",

"name": "Drafts",

"filters": [

{

"key": "status",

"value": "DRAFT"

}

"query": "status:\"DRAFT\"",

"searchTerms": ""

{

"id": "gid://shopify/SavedSearch/1068136124",

"legacyResourceId": "1068136124",

"name": "Products from Vendor X",

"filters": [

{

"key": "vendor",

"value": "Vendor X"

}

"query": "vendor:\"Vendor X\"",

"searchTerms": ""

}

]

}