listOptions - Product Module Reference

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

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

Example

To retrieve a list of product options using their IDs:

const options = await productModuleService.listOptions({
 id: ["opt_123", "opt_321"],
})

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

const options = await productModuleService.listOptions(
  {
    id: ["opt_123", "opt_321"],
  },
  {
    relations: ["product"],
  }
)

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 options = await productModuleService.listOptions(
  {
    id: ["opt_123", "opt_321"],
  },
  {
    relations: ["product"],
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterableProductOptionProps

The filters applied on the retrieved product options.

configFindConfig<ProductOptionDTO>

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

sharedContextContext

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

Returns

PromisePromise<ProductOptionDTO[]>Required

The list of product options.