retrieveCategory - Product Module Reference

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

This method is used to retrieve a product category by its ID.

Example

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

const category =
  await productModuleService.retrieveCategory("pcat_123")

To specify relations that should be retrieved:

const category = await productModuleService.retrieveCategory(
  "pcat_123",
  {
    relations: ["products"],
  }
)

Parameters

productCategoryIdstringRequired

The ID of the product category to retrieve.

configFindConfig<ProductCategoryDTO>

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.

sharedContextContext

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

Returns

PromisePromise<ProductCategoryDTO>Required

The retrieved product category.