listProductCategories - Product Module Reference

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

Example#

To retrieve a list of product categories using their IDs:

Code
1const categories = await productModuleService.listProductCategories({2  id: ["pcat_123", "pcat_321"],3})

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

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 categories = await productModuleService.listProductCategories(2  {3    id: ["pcat_123", "pcat_321"],4  },5  {6    relations: ["products"],7  }8)

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 categories = await productModuleService.listProductCategories(2  {3    id: ["pcat_123", "pcat_321"],4  },5  {6    relations: ["products"],7    take: 20,8    skip: 2,9  }10)

Parameters#

filtersFilterableProductCategoryPropsOptional

The filters to be applied on the retrieved product categories.

configFindConfig<ProductCategoryDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<ProductCategoryDTO[]>

The list of product categories.