retrievePriceSet - Pricing Module Reference

This documentation provides a reference to the retrievePriceSet method. This belongs to the Pricing 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 price set by its ID.

Example#

A simple example that retrieves a price set by its ID:

Code
1const priceSet =2  await pricingModuleService.retrievePriceSet("pset_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 priceSet = await pricingModuleService.retrievePriceSet(2  "pset_123",3  {4    relations: ["prices"],5  }6)

Parameters#

idstring

The ID of the price set to retrieve.

configFindConfig<PriceSetDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<PriceSetDTO>

The retrieved price set.