retrieve - Pricing Module Reference

This documentation provides a reference to the retrieve method. This belongs to the Pricing Module.

This method is used to retrieve a price set by its ID.

Example

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

const priceSet =
  await pricingModuleService.retrieve("pset_123")

To specify relations that should be retrieved:

const priceSet = await pricingModuleService.retrieve(
  "pset_123",
  {
    relations: ["prices"],
  }
)

Parameters

idstringRequired

The ID of the price set to retrieve.

configFindConfig<PriceSetDTO>

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.

sharedContextContext

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

Returns

PromisePromise<PriceSetDTO>Required

The retrieved price set.