Skip to main content
openbridge.products.list().search(query)
Searches products by a text query.

Parameters

ParamTypeRequiredDescription
querystringYesSearch query string

Returns

ProductListBuilder (chainable)

Examples

const { items } = await openbridge.products.list().search('cotton shirt')

With limit

const { items } = await openbridge.products
    .list()
    .search('blue')
    .limit(20)

With field selection

const { items } = await openbridge.products
    .list()
    .search('summer dress')
    .limit(10)
    .select(['title', 'handle', 'priceRange', 'featuredImage'])

Search within collection

const { items } = await openbridge.products
    .list()
    .collection('womens')
    .search('dress')
    .limit(12)