calculatePrices - Pricing Module Reference

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

This method is used to calculate prices based on the provided filters and context.

Example

When you calculate prices, you must at least specify the currency code:

const price = await pricingModuleService.calculatePrices(
  {
    id: ["pset_123", "pset_321"],
  },
  {
    context: {
      currency_code: "usd",
    },
  }
)

To calculate prices for specific minimum and/or maximum quantity:

const price = await pricingModuleService.calculatePrices(
  {
    id: ["pset_123", "pset_321"],
  },
  {
    context: {
      currency_code: "usd",
      min_quantity: 4,
    },
  }
)

To calculate prices for custom rule types:

const price = await pricingModuleService.calculatePrices(
  {
    id: ["pset_123", "pset_321"],
  },
  {
    context: {
      currency_code: "usd",
      region_id: "US",
    },
  }
)

Parameters

filtersPricingFiltersRequired

The filters to apply on prices.

contextPricingContext

The context used to select the prices. For example, you can specify the region ID in this context, and only prices having the same value will be retrieved.

sharedContextContext

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

Returns

PromisePromise<CalculatedPriceSet[]>Required

The calculated prices matching the context and filters provided.