listProductTypes - Product Module Reference

This documentation provides a reference to the listProductTypes 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 types based on optional filters and configuration.

Example#

To retrieve a list of product types using their IDs:

Code
1const productTypes = await productModuleService.listProductTypes({2  id: ["ptyp_123", "ptyp_321"],3})

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 productTypes = await productModuleService.listProductTypes(2  {3    id: ["ptyp_123", "ptyp_321"],4  },5  {6    take: 20,7    skip: 2,8  }9)

Parameters#

filtersFilterableProductTypePropsOptional

The filters to apply on the retrieved product types.

configFindConfig<ProductTypeDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<ProductTypeDTO[]>

The list of product types.

Was this page helpful?