Skip to main content
shoppy.collections.search(query)
Filters collections by a text query.
This is a chainable method. Call .list() to execute.

​
Parameters

ParamTypeRequiredDescription
querystringYesSearch query string

​
Returns

CollectionsQueryBuilder (chainable)

​
Examples

const { items } = await shoppy.collections.search('sale').list()

​
With limit

const { items } = await shoppy.collections.search('summer').limit(5).list()

​
With field selection

const { items } = await shoppy.collections
    .search('new')
    .select(['title', 'handle', 'image'])
    .list()

​
Combined with pagination

const page1 = await shoppy.collections.search('featured').limit(10).list()

if (page1.pageInfo.hasNextPage) {
    const page2 = await shoppy.collections
        .search('featured')
        .limit(10)
        .after(page1.pageInfo.endCursor)
        .list()
}