medusa-store/docs/content/references/services/classes/PricingService.md

Class: PricingService

Allows retrieval of prices.

Hierarchy

• TransactionBaseService<PricingService>

  ↳ PricingService

Constructors

constructor

• new PricingService(__namedParameters)

Parameters

Name	Type
__namedParameters	InjectedDependencies

Overrides

TransactionBaseService<PricingService&gt;.constructor

Defined in

services/pricing.ts:40

Properties

configModule

• Protected Optional Readonly configModule: Record<string, unknown>

Inherited from

TransactionBaseService.configModule

---

container

• Protected Readonly container: unknown

Inherited from

TransactionBaseService.container

---

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

services/pricing.ts:33

---

priceSelectionStrategy

• Protected Readonly priceSelectionStrategy: IPriceSelectionStrategy

Defined in

services/pricing.ts:37

---

productVariantService

• Protected Readonly productVariantService: ProductVariantService

Defined in

services/pricing.ts:38

---

regionService

• Protected Readonly regionService: RegionService

Defined in

services/pricing.ts:35

---

taxProviderService

• Protected Readonly taxProviderService: TaxProviderService

Defined in

services/pricing.ts:36

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

services/pricing.ts:34

Methods

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

Type parameters

Name
TResult
TError

Parameters

Name	Type	Description
work	(transactionManager: EntityManager) => Promise<TResult>	the transactional work to be done
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>	the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>	Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

interfaces/transaction-base-service.ts:53

---

calculateTaxes

▸ calculateTaxes(variantPricing, productRates): Promise<TaxedPricing>

Gets the prices for a product variant

Parameters

Name	Type	Description
variantPricing	ProductVariantPricing	the prices retrieved from a variant
productRates	TaxServiceRate[]	the tax rates that the product has applied

Returns

Promise<TaxedPricing>

The tax related variant prices.

Defined in

services/pricing.ts:102

---

collectPricingContext

▸ collectPricingContext(context): Promise<PricingContext>

Collects additional information neccessary for completing the price selection.

Parameters

Name	Type	Description
context	PriceSelectionContext	the price selection context to use

Returns

Promise<PricingContext>

The pricing context

Defined in

services/pricing.ts:63

---

getProductPricing

▸ getProductPricing(product, context): Promise<Record<string, ProductVariantPricing>>

Gets all the variant prices for a product. All the product's variants will be fetched.

Parameters

Name	Type	Description
product	Pick<Product, "id" | "variants">	the product to get pricing for.
context	PriceSelectionContext	the price selection context to use

Returns

Promise<Record<string, ProductVariantPricing>>

A map of variant ids to their corresponding prices

Defined in

services/pricing.ts:292

---

getProductPricingById

▸ getProductPricingById(productId, context): Promise<Record<string, ProductVariantPricing>>

Gets all the variant prices for a product by the product id

Parameters

Name	Type	Description
productId	string	the id of the product to get prices for
context	PriceSelectionContext	the price selection context to use

Returns

Promise<Record<string, ProductVariantPricing>>

A map of variant ids to their corresponding prices

Defined in

services/pricing.ts:310

---

getProductPricing_

▸ Private getProductPricing_(productId, variants, context): Promise<Record<string, ProductVariantPricing>>

Parameters

Name	Type
productId	string
variants	ProductVariant[]
context	PricingContext

Returns

Promise<Record<string, ProductVariantPricing>>

Defined in

services/pricing.ts:254

---

getProductVariantPricing

▸ getProductVariantPricing(variant, context): Promise<ProductVariantPricing>

Gets the prices for a product variant.

Parameters

Name	Type	Description
variant	Pick<ProductVariant, "id" | "product_id">	the id of the variant to get prices for
context	PriceSelectionContext | PricingContext	the price selection context to use

Returns

Promise<ProductVariantPricing>

The product variant prices

Defined in

services/pricing.ts:180

---

getProductVariantPricingById

▸ getProductVariantPricingById(variantId, context): Promise<ProductVariantPricing>

Gets the prices for a product variant by a variant id.

Parameters

Name	Type	Description
variantId	string	the id of the variant to get prices for
context	PriceSelectionContext | PricingContext	the price selection context to use

Returns

Promise<ProductVariantPricing>

The product variant prices

Defined in

services/pricing.ts:218

---

getProductVariantPricing_

▸ Private getProductVariantPricing_(variantId, taxRates, context): Promise<ProductVariantPricing>

Parameters

Name	Type
variantId	string
taxRates	TaxServiceRate[]
context	PricingContext

Returns

Promise<ProductVariantPricing>

Defined in

services/pricing.ts:138

---

getShippingOptionPricing

▸ getShippingOptionPricing(shippingOption, context): Promise<PricedShippingOption>

Gets the prices for a shipping option.

Parameters

Name	Type	Description
shippingOption	ShippingOption	the shipping option to get prices for
context	PriceSelectionContext | PricingContext	the price selection context to use

Returns

Promise<PricedShippingOption>

The shipping option prices

Defined in

services/pricing.ts:396

---

setProductPrices

▸ setProductPrices(products, context?): Promise<(Product | PricedProduct)[]>

Set additional prices on a list of products.

Parameters

Name	Type	Description
products	Product[]	list of products on which to set additional prices
context	PriceSelectionContext	the price selection context to use

Returns

Promise<(Product | PricedProduct)[]>

A list of products with variants decorated with prices

Defined in

services/pricing.ts:353

---

setShippingOptionPrices

▸ setShippingOptionPrices(shippingOptions, context?): Promise<PricedShippingOption[]>

Set additional prices on a list of shipping options.

Parameters

Name	Type	Description
shippingOptions	ShippingOption[]	list of shipping options on which to set additional prices
context	Omit<PriceSelectionContext, "region_id">	the price selection context to use

Returns

Promise<PricedShippingOption[]>

A list of shipping options with prices

Defined in

services/pricing.ts:445

---

setVariantPrices

▸ setVariantPrices(variants, context): Promise<PricedVariant[]>

Set additional prices on a list of product variants.

Parameters

Name	Type	Description
variants	ProductVariant[]	list of variants on which to set additional prices
context	PriceSelectionContext	the price selection context to use

Returns

Promise<PricedVariant[]>

A list of products with variants decorated with prices

Defined in

services/pricing.ts:328

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
err	Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

interfaces/transaction-base-service.ts:34

---

withTransaction

▸ withTransaction(transactionManager?): PricingService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

PricingService

Inherited from

TransactionBaseService.withTransaction

Defined in

interfaces/transaction-base-service.ts:16