collectionSavedSearches

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

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the collectionSavedSearches action (under Collection).
Fill in the fields below, then reference the result from later steps as {{collectionsavedsearches.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query CollectionSavedSearches($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean) {
  collectionSavedSearches(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
  ) {
    edges {
      cursor
      node {
        filters
        id
        legacyResourceId
        name
        query
        resourceType
        searchTerms
      }
    }
    nodes {
      filters {
        key
        value
      }
      id
      legacyResourceId
      name
      query
      resourceType
      searchTerms
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

json

{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false
}

Response

Read the result with {{collectionsavedsearches.response.data.data.collectionSavedSearches}}. If the API returns errors, the step fails and they are at {{collectionsavedsearches.response.data.errors}}.

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

filtersobject

idobject

legacyResourceIdobject

nameobject

queryobject

resourceTypeobject

searchTermsobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?