medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.PricingService.md

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: PricingService

internal.internal.PricingService

Allows retrieval of prices.

Hierarchy

• TransactionBaseService

  ↳ PricingService

Properties

__configModule__

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

Inherited from

TransactionBaseService.configModule

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:5

---

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.container

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:4

---

__moduleDeclaration__

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

Inherited from

TransactionBaseService.moduleDeclaration

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:6

---

featureFlagRouter

• Protected Readonly featureFlagRouter: FlagRouter

Defined in

packages/medusa/dist/services/pricing.d.ts:25

---

getProductPricing_

• Private getProductPricing_: any

Defined in

packages/medusa/dist/services/pricing.d.ts:69

---

getProductVariantPricing_

• Private getProductVariantPricing_: any

Defined in

packages/medusa/dist/services/pricing.d.ts:41

---

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:7

---

priceSelectionStrategy

• Protected Readonly priceSelectionStrategy: IPriceSelectionStrategy

Defined in

packages/medusa/dist/services/pricing.d.ts:23

---

productVariantService

• Protected Readonly productVariantService: ProductVariantService

Defined in

packages/medusa/dist/services/pricing.d.ts:24

---

regionService

• Protected Readonly regionService: RegionService

Defined in

packages/medusa/dist/services/pricing.d.ts:21

---

taxProviderService

• Protected Readonly taxProviderService: TaxProviderService

Defined in

packages/medusa/dist/services/pricing.d.ts:22

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:8

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:9

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

packages/medusa/dist/interfaces/transaction-base-service.d.ts:24

---

calculateTaxes

▸ calculateTaxes(variantPricing, productRates): 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

TaxedPricing

The tax related variant prices.

Defined in

packages/medusa/dist/services/pricing.d.ts:40

---

collectPricingContext

▸ collectPricingContext(context): Promise<PricingContext>

Collects additional information necessary 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

packages/medusa/dist/services/pricing.d.ts:33

---

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

packages/medusa/dist/services/pricing.d.ts:77

---

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

packages/medusa/dist/services/pricing.d.ts:84

---

getProductVariantPricing

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

Gets the prices for a product variant.

Parameters

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

Returns

Promise<ProductVariantPricing>

The product variant prices

Defined in

packages/medusa/dist/services/pricing.d.ts:48

---

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

Deprecated

Use getProductVariantsPricing instead.

Defined in

packages/medusa/dist/services/pricing.d.ts:56

---

getProductVariantsPricing

▸ getProductVariantsPricing(data, context): Promise<{ [variant_id: string]: ProductVariantPricing; }>

Gets the prices for a collection of variants.

Parameters

Name	Type	Description
data	{ quantity?: number ; variantId: string }[]
context	PriceSelectionContext | PricingContext	the price selection context to use

Returns

Promise<{ [variant_id: string]: ProductVariantPricing; }>

The product variant prices

Defined in

packages/medusa/dist/services/pricing.d.ts:63

---

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

packages/medusa/dist/services/pricing.d.ts:105

---

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

packages/medusa/dist/services/pricing.d.ts:98

---

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

packages/medusa/dist/services/pricing.d.ts:112

---

setVariantPrices

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

Set additional prices on a list of product variants.

Parameters

Name	Type	Description
variants	ProductVariant[]
context?	PriceSelectionContext	the price selection context to use

Returns

Promise<PricedVariant[]>

A list of products with variants decorated with prices

Defined in

packages/medusa/dist/services/pricing.d.ts:91

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:12

---

withTransaction

▸ withTransaction(transactionManager?): PricingService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

PricingService

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:11