Skip to main content
openbridge.products.list().collection(idOrHandle)
Filters products to only those in a specific collection.

​
Parameters

ParamTypeRequiredDescription
idOrHandlestringYesCollection handle or GID

​
Supported formats

FormatExample
Handle'summer-sale'
Shopify GID'gid://shopify/Collection/448629506282'

​
Returns

ProductListBuilder (chainable)

​
Examples

​
By handle

const { items } = await openbridge.products.list().collection('summer-sale')

​
By GID

const { items } = await openbridge.products
    .list()
    .collection('gid://shopify/Collection/448629506282')

​
With limit

const { items } = await openbridge.products
    .list()
    .collection('new-arrivals')
    .limit(8)

​
With field selection

const { items } = await openbridge.products
    .list()
    .collection('sale')
    .limit(12)
    .select([
        'title',
        'handle',
        'priceRange',
        'compareAtPriceRange',
        'featuredImage'
    ])

​
Paginate collection

const page1 = await openbridge.products.list().collection('all').limit(12)

if (page1.pageInfo.hasNextPage) {
    const page2 = await openbridge.products
        .list()
        .collection('all')
        .limit(12)
        .after(page1.pageInfo.endCursor)
}