listTypes - Product Module Reference

Beta

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

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:

const productTypes = await productModuleService.listTypes({
  id: ["ptyp_123", "ptyp_321"],
})

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

const productTypes = await productModuleService.listTypes(
  {
    id: ["ptyp_123", "ptyp_321"],
  },
  {
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterableProductTypeProps

The filters to apply on the retrieved product types.

configFindConfig<ProductTypeDTO>

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.

sharedContextContext

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

Returns

PromisePromise<ProductTypeDTO[]>Required

The list of product types.