retrieveProductCategory - Product Module Reference

This documentation provides a reference to the retrieveProductCategory 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 category by its ID.

Example#

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

Code
1const category =2  await productModuleService.retrieveProductCategory("pcat_123")

To specify relations that should be retrieved:

Code
1const category = await productModuleService.retrieveProductCategory(2  "pcat_123",3  {4    relations: ["products"],5  }6)

Parameters#

productCategoryIdstring

The ID of the product category to retrieve.

configFindConfig<ProductCategoryDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<ProductCategoryDTO>

The retrieved product category.

Was this page helpful?