listAndCountProductCollections - Product Module Reference

This documentation provides a reference to the listAndCountProductCollections method. This belongs to the Product Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

This method is used to retrieve a paginated list of product collections along with the total count of available product collections satisfying the provided filters.

Example#

To retrieve a list of product collections using their IDs:

Code
1const [collections, count] =2  await productModuleService.listAndCountProductCollections({3    id: ["pcol_123", "pcol_321"],4  })

To specify relations that should be retrieved within the product collections:

Code
1const [collections, count] =2  await productModuleService.listAndCountProductCollections(3    {4      id: ["pcol_123", "pcol_321"],5    },6    {7      relations: ["products"],8    }9  )

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

Code
1const [collections, count] =2  await productModuleService.listAndCountProductCollections(3    {4      id: ["pcol_123", "pcol_321"],5    },6    {7      relations: ["products"],8      take: 20,9      skip: 2,10    }11  )

Parameters#

filtersFilterableProductCollectionPropsOptional

The filters applied on the retrieved product collections.

configFindConfig<ProductCollectionDTO>Optional

The configurations determining how the product collections are retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a product collection.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<[ProductCollectionDTO[], number]>

The list of product collections along with the total count.

Was this page helpful?