listAndCountProducts - Product Module Reference

This documentation provides a reference to the listAndCountProducts 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 products along with the total count of available products satisfying the provided filters.

Example#

To retrieve a list of products using their IDs:

Code
1const [products, count] =2  await productModuleService.listAndCountProducts({3    id: ["prod_123", "prod_321"],4  })

To specify relations that should be retrieved within the products:

Note: You can only retrieve data models defined in the same module. To retrieve linked data models from other modules, use Query instead.

Code
1const [products, count] =2  await productModuleService.listAndCountProducts(3    {4      id: ["prod_123", "prod_321"],5    },6    {7      relations: ["categories"],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 [products, count] =2  await productModuleService.listAndCountProducts(3    {4      id: ["prod_123", "prod_321"],5    },6    {7      relations: ["categories"],8      take: 20,9      skip: 2,10    }11  )

Parameters#

filtersFilterableProductPropsOptional

The filters to apply on the retrieved products.

configFindConfig<ProductDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<[ProductDTO[], number]>

The list of products along with the total count.