914d773d3a
* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
14 KiB
Class: PricingService
Allows retrieval of prices.
Hierarchy
-
TransactionBaseService↳
PricingService
Constructors
constructor
• new PricingService(__namedParameters)
Parameters
| Name | Type |
|---|---|
__namedParameters |
InjectedDependencies |
Overrides
TransactionBaseService.constructor
Defined in
medusa/src/services/pricing.ts:42
Properties
__configModule__
• Protected Optional Readonly __configModule__: Record<string, unknown>
Inherited from
TransactionBaseService.__configModule__
Defined in
medusa/src/interfaces/transaction-base-service.ts:14
__container__
• Protected Readonly __container__: any
Inherited from
TransactionBaseService.__container__
Defined in
medusa/src/interfaces/transaction-base-service.ts:13
__moduleDeclaration__
• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
medusa/src/interfaces/transaction-base-service.ts:15
featureFlagRouter
• Protected Readonly featureFlagRouter: FlagRouter
Defined in
medusa/src/services/pricing.ts:40
manager_
• Protected manager_: EntityManager
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
priceSelectionStrategy
• Protected Readonly priceSelectionStrategy: IPriceSelectionStrategy
Defined in
medusa/src/services/pricing.ts:38
productVariantService
• Protected Readonly productVariantService: ProductVariantService
Defined in
medusa/src/services/pricing.ts:39
regionService
• Protected Readonly regionService: RegionService
Defined in
medusa/src/services/pricing.ts:36
taxProviderService
• Protected Readonly taxProviderService: TaxProviderService
Defined in
medusa/src/services/pricing.ts:37
transactionManager_
• Protected transactionManager_: undefined | EntityManager
Inherited from
TransactionBaseService.transactionManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:6
Accessors
activeManager_
• Protected get activeManager_(): EntityManager
Returns
EntityManager
Inherited from
TransactionBaseService.activeManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:8
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
medusa/src/interfaces/transaction-base-service.ts:56
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
medusa/src/services/pricing.ts:101
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
medusa/src/services/pricing.ts:65
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
medusa/src/services/pricing.ts:419
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
medusa/src/services/pricing.ts:437
getProductPricing_
▸ Private getProductPricing_(data, context): Promise<Map<string, Record<string, ProductVariantPricing>>>
Parameters
| Name | Type |
|---|---|
data |
{ productId: string ; variants: ProductVariant[] }[] |
context |
PricingContext |
Returns
Promise<Map<string, Record<string, ProductVariantPricing>>>
Defined in
medusa/src/services/pricing.ts:362
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
medusa/src/services/pricing.ts:216
getProductVariantPricingById
▸ getProductVariantPricingById(variantId, context): Promise<ProductVariantPricing>
Gets the prices for a product variant by a variant id.
Deprecated
Use getProductVariantsPricing instead.
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
medusa/src/services/pricing.ts:265
getProductVariantPricing_
▸ Private getProductVariantPricing_(data, context): Promise<Map<string, ProductVariantPricing>>
Parameters
| Name | Type |
|---|---|
data |
{ quantity?: number ; variantId: string }[] |
context |
PricingContext |
Returns
Promise<Map<string, ProductVariantPricing>>
Defined in
medusa/src/services/pricing.ts:163
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
medusa/src/services/pricing.ts:310
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
medusa/src/services/pricing.ts:526
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
medusa/src/services/pricing.ts:486
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
medusa/src/services/pricing.ts:588
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
medusa/src/services/pricing.ts:459
shouldRetryTransaction_
▸ Protected shouldRetryTransaction_(err): boolean
Parameters
| Name | Type |
|---|---|
err |
Record<string, unknown> | { code: string } |
Returns
boolean
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
medusa/src/interfaces/transaction-base-service.ts:37
withTransaction
▸ withTransaction(transactionManager?): PricingService
Parameters
| Name | Type |
|---|---|
transactionManager? |
EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction