retrieveOption - Product Module Reference

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

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

Example

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

const option =
  await productModuleService.retrieveOption("opt_123")

To specify relations that should be retrieved:

const option = await productModuleService.retrieveOption(
  "opt_123",
  {
    relations: ["product"],
  }
)

Parameters

optionIdstringRequired

The ID of the product option to retrieve.

configFindConfig<ProductOptionDTO>

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

sharedContextContext

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

Returns

PromisePromise<ProductOptionDTO>Required

The retrieved product option.