list - Product Module Reference

Beta

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

This method is used to retrieve a paginated list of price sets based on optional filters and configuration.

Example

To retrieve a list of products using their IDs:

const products = await productModuleService.list({
  id: ["prod_123", "prod_321"],
})

To specify relations that should be retrieved within the products:

const products = await productModuleService.list(
  {
    id: ["prod_123", "prod_321"],
  },
  {
    relations: ["categories"],
  }
)

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 products = await productModuleService.list(
  {
    id: ["prod_123", "prod_321"],
  },
  {
    relations: ["categories"],
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterableProductProps

The filters to apply on the retrieved products.

configFindConfig<ProductDTO>

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

sharedContextContext

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

Returns

PromisePromise<ProductDTO[]>Required

The list of products.