retrievePriceList - Pricing Module Reference

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

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

Example

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

const priceList =
  await pricingModuleService.retrievePriceList("plist_123")

To specify relations that should be retrieved:

const priceList =
  await pricingModuleService.retrievePriceList("plist_123", {
    relations: ["prices"],
  })

Parameters

idstringRequired

The ID of the price list to retrieve.

configFindConfig<PriceListDTO>

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

sharedContextContext

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

Returns

PromisePromise<PriceListDTO>Required

The retrieved price list.