list - Pricing Module Reference

Beta

This documentation provides a reference to the list method. This belongs to the Pricing 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 price sets using their IDs:

const priceSets = await pricingModuleService.list({
  id: ["pset_123", "pset_321"],
})

To specify relations that should be retrieved within the price sets:

const priceSets = await pricingModuleService.list(
  {
    id: ["pset_123", "pset_321"],
  },
  {
    relations: ["prices"],
  }
)

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 priceSets = await pricingModuleService.list(
  {
    id: ["pset_123", "pset_321"],
  },
  {
    relations: ["prices"],
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterablePriceSetProps

The filters to apply on the retrieved price lists.

configFindConfig<PriceSetDTO>

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

sharedContextContext

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

Returns

PromisePromise<PriceSetDTO[]>Required

The list of price sets.