listAndCountProductOptionValues - Product Module Reference

This documentation provides a reference to the listAndCountProductOptionValues 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 option values along with the total count of available product option values satisfying the provided filters.

Example#

To retrieve a list of product option values using their IDs:

Code
1const [options, count] =2  await productModuleService.listAndCountProductOptionValues({3    id: ["optval_123", "optval_321"],4  })

To specify relations that should be retrieved within the product option values:

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 [options, count] =2  await productModuleService.listAndCountProductOptionValues(3    {4      id: ["optval_123", "optval_321"],5    },6    {7      relations: ["option"],8    }9  )

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 [options, count] =2  await productModuleService.listAndCountProductOptionValues(3    {4      id: ["optval_123", "optval_321"],5    },6    {7      take: 20,8      skip: 2,9    }10  )

Parameters#

filtersFilterableProductOptionValuePropsOptional

The filters applied on the retrieved product option values.

configFindConfig<ProductOptionValueDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<[ProductOptionValueDTO[], number]>

The list of product option values along with the total count.