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

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: TaxProviderService

internal.internal.TaxProviderService

Finds tax providers and assists in tax related operations.

Hierarchy

• TransactionBaseService

  ↳ TaxProviderService

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

---

cacheService_

• Protected Readonly cacheService_: ICacheService

Defined in

packages/medusa/dist/services/tax-provider.d.ts:19

---

container_

• Protected Readonly container_: AwilixContainer<any>

Defined in

packages/medusa/dist/services/tax-provider.d.ts:18

---

eventBus_

• Protected Readonly eventBus_: IEventBusService

Defined in

packages/medusa/dist/services/tax-provider.d.ts:24

---

getCacheKey

• Private getCacheKey: any

The cache key to get cache hits by.

Param

the entity id to cache

Param

the region id to cache

Defined in

packages/medusa/dist/services/tax-provider.d.ts:99

---

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

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

---

smTaxLineRepo_

• Protected Readonly smTaxLineRepo_: Repository<ShippingMethodTaxLine> & { deleteForCart: (cartId: string) => Promise<void> ; upsertLines: (lines: ShippingMethodTaxLine[]) => Promise<ShippingMethodTaxLine[]> }

Defined in

packages/medusa/dist/services/tax-provider.d.ts:22

---

taxLineRepo_

• Protected Readonly taxLineRepo_: Repository<LineItemTaxLine> & { deleteForCart: (cartId: string) => Promise<void> ; upsertLines: (lines: LineItemTaxLine[]) => Promise<LineItemTaxLine[]> }

Defined in

packages/medusa/dist/services/tax-provider.d.ts:21

---

taxProviderRepo_

• Protected Readonly taxProviderRepo_: Repository<TaxProvider>

Defined in

packages/medusa/dist/services/tax-provider.d.ts:23

---

taxRateService_

• Protected Readonly taxRateService_: TaxRateService

Defined in

packages/medusa/dist/services/tax-provider.d.ts:20

---

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

---

clearLineItemsTaxLines

▸ clearLineItemsTaxLines(itemIds): Promise<void>

Parameters

Name	Type
itemIds	string[]

Returns

Promise<void>

Defined in

packages/medusa/dist/services/tax-provider.d.ts:33

---

clearTaxLines

▸ clearTaxLines(cartId): Promise<void>

Parameters

Name	Type
cartId	string

Returns

Promise<void>

Defined in

packages/medusa/dist/services/tax-provider.d.ts:34

---

createShippingTaxLines

▸ createShippingTaxLines(shippingMethod, calculationContext): Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>

Persists the tax lines relevant for a shipping method to the database. Used for return shipping methods.

Parameters

Name	Type	Description
shippingMethod	ShippingMethod	the shipping method to create tax lines for
calculationContext	TaxCalculationContext	the calculation context to get tax lines by

Returns

Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>

the newly created tax lines

Defined in

packages/medusa/dist/services/tax-provider.d.ts:49

---

createTaxLines

▸ createTaxLines(cartOrLineItems, calculationContext): Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>

Persists the tax lines relevant for an order to the database.

Parameters

Name	Type	Description
cartOrLineItems	Cart | LineItem[]	the cart or line items to create tax lines for
calculationContext	TaxCalculationContext	the calculation context to get tax lines by

Returns

Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>

the newly created tax lines

Defined in

packages/medusa/dist/services/tax-provider.d.ts:41

---

getRegionRatesForProduct

▸ getRegionRatesForProduct(productIds, region): Promise<Map<string, TaxServiceRate[]>>

Gets the tax rates configured for a product. The rates are cached between calls.

Parameters

Name	Type	Description
productIds	string | string[]
region	RegionDetails	the region to get configured rates for.

Returns

Promise<Map<string, TaxServiceRate[]>>

the tax rates configured for the shipping option. A map by product id

Defined in

packages/medusa/dist/services/tax-provider.d.ts:92

---

getRegionRatesForShipping

▸ getRegionRatesForShipping(optionId, regionDetails): Promise<TaxServiceRate[]>

Gets the tax rates configured for a shipping option. The rates are cached between calls.

Parameters

Name	Type	Description
optionId	string	the option id of the shipping method.
regionDetails	RegionDetails	the region to get configured rates for.

Returns

Promise<TaxServiceRate[]>

the tax rates configured for the shipping option.

Defined in

packages/medusa/dist/services/tax-provider.d.ts:84

---

getShippingTaxLines

▸ getShippingTaxLines(shippingMethod, calculationContext): Promise<ShippingMethodTaxLine[]>

Gets the relevant tax lines for a shipping method. Note: this method doesn't persist the tax lines. Use createShippingTaxLines if you wish to persist the tax lines to the DB layer.

Parameters

Name	Type	Description
shippingMethod	ShippingMethod	the shipping method to get tax lines for
calculationContext	TaxCalculationContext	the calculation context to get tax lines by

Returns

Promise<ShippingMethodTaxLine[]>

the computed tax lines

Defined in

packages/medusa/dist/services/tax-provider.d.ts:58

---

getTaxLines

▸ getTaxLines(lineItems, calculationContext): Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>

Gets the relevant tax lines for an order or cart. If an order is provided the order's tax lines will be returned. If a cart is provided the tax lines will be computed from the tax rules and potentially a 3rd party tax plugin. Note: this method doesn't persist the tax lines. Use createTaxLines if you wish to persist the tax lines to the DB layer.

Parameters

Name	Type	Description
lineItems	LineItem[]	the cart or order to get tax lines for
calculationContext	TaxCalculationContext	the calculation context to get tax lines by

Returns

Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>

the computed tax lines

Defined in

packages/medusa/dist/services/tax-provider.d.ts:69

---

getTaxLinesMap

▸ Protected getTaxLinesMap(items, calculationContext): Promise<TaxLinesMaps>

Return a map of tax lines for line items and shipping methods

Parameters

Name	Type
items	LineItem[]
calculationContext	TaxCalculationContext

Returns

Promise<TaxLinesMaps>

Defined in

packages/medusa/dist/services/tax-provider.d.ts:76

---

list

▸ list(): Promise<TaxProvider[]>

Returns

Promise<TaxProvider[]>

Defined in

packages/medusa/dist/services/tax-provider.d.ts:26

---

registerInstalledProviders

▸ registerInstalledProviders(providers): Promise<void>

Parameters

Name	Type
providers	string[]

Returns

Promise<void>

Defined in

packages/medusa/dist/services/tax-provider.d.ts:100

---

retrieveProvider

▸ retrieveProvider(region): ITaxService

Retrieves the relevant tax provider for the given region.

Parameters

Name	Type	Description
region	Region	the region to get tax provider for.

Returns

ITaxService

the region specific tax provider

Defined in

packages/medusa/dist/services/tax-provider.d.ts:32

---

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?): TaxProviderService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

TaxProviderService

Inherited from

TransactionBaseService.withTransaction

Defined in

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