listCollections - Product Module Reference

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

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

Example

To retrieve a list of product collections using their IDs:

const collections =
  await productModuleService.listCollections({
    id: ["pcol_123", "pcol_321"],
  })

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

const collections =
  await productModuleService.listCollections(
    {
      id: ["pcol_123", "pcol_321"],
    },
    {
      relations: ["products"],
    }
  )

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 collections =
  await productModuleService.listCollections(
    {
      id: ["pcol_123", "pcol_321"],
    },
    {
      relations: ["products"],
      take: 20,
      skip: 2,
    }
  )

Parameters

filtersFilterableProductCollectionProps

The filters applied on the retrieved product collections.

configFindConfig<ProductCollectionDTO>

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

sharedContextContext

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

Returns

PromisePromise<ProductCollectionDTO[]>Required

The list of product collections.