retrieveProductCollection - Product Module Reference

This documentation provides a reference to the retrieveProductCollection 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 product collection by its ID.

Example#

A simple example that retrieves a product collection by its ID:

Code
1const collection =2  await productModuleService.retrieveProductCollection("pcol_123")

To specify relations that should be retrieved:

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 collection =2  await productModuleService.retrieveProductCollection("pcol_123", {3    relations: ["products"],4  })

Parameters#

productCollectionIdstring

The ID of the product collection to retrieve.

configFindConfig<ProductCollectionDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<ProductCollectionDTO>

The retrieved product collection.