Skip to main content

Class: TaxProviderService

Finds tax providers and assists in tax related operations.

Hierarchy

  • "medusa-interfaces"

    TaxProviderService

Constructors

constructor

new TaxProviderService(container)

Parameters

NameType
containerAwilixContainer<any>

Overrides

BaseService.constructor

Defined in

services/tax-provider.ts:44

Properties

container_

Private container_: AwilixContainer<any>

Defined in

services/tax-provider.ts:35


manager_

Private manager_: EntityManager

Defined in

services/tax-provider.ts:36


redis_

Private redis_: Redis

Defined in

services/tax-provider.ts:42


smTaxLineRepo_

Private smTaxLineRepo_: typeof ShippingMethodTaxLineRepository

Defined in

services/tax-provider.ts:40


taxLineRepo_

Private taxLineRepo_: typeof LineItemTaxLineRepository

Defined in

services/tax-provider.ts:39


taxProviderRepo_

Private taxProviderRepo_: typeof TaxProviderRepository

Defined in

services/tax-provider.ts:41


taxRateService_

Private taxRateService_: TaxRateService

Defined in

services/tax-provider.ts:38


transactionManager_

Private transactionManager_: EntityManager

Defined in

services/tax-provider.ts:37

Methods

clearTaxLines

clearTaxLines(cartId): Promise<void>

Parameters

NameType
cartIdstring

Returns

Promise<void>

Defined in

services/tax-provider.ts:98


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

NameTypeDescription
shippingMethodShippingMethodthe shipping method to create tax lines for
calculationContextTaxCalculationContextthe calculation context to get tax lines by

Returns

Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>

the newly created tax lines

Defined in

services/tax-provider.ts:166


createTaxLines

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

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

Parameters

NameTypeDescription
cartOrLineItemsCart | LineItem[]the cart or line items to create tax lines for
calculationContextTaxCalculationContextthe calculation context to get tax lines by

Returns

Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>

the newly created tax lines

Defined in

services/tax-provider.ts:116


getCacheEntry

Private getCacheEntry(productId, regionId): Promise<null | TaxServiceRate[]>

Gets the cache results for a set of ids

Parameters

NameTypeDescription
productIdstringthe product id to cache
regionIdstringthe region id to cache

Returns

Promise<null | TaxServiceRate[]>

the cached result or null

Defined in

services/tax-provider.ts:450


getCacheKey

Private getCacheKey(productId, regionId): string

The cache key to get cache hits by.

Parameters

NameTypeDescription
productIdstringthe product id to cache
regionIdstringthe region id to cache

Returns

string

the cache key to use for the id set

Defined in

services/tax-provider.ts:419


getRegionRatesForProduct

getRegionRatesForProduct(productId, region): Promise<TaxServiceRate[]>

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

Parameters

NameTypeDescription
productIdstringthe product id to get rates for
regionRegionthe region to get configured rates for.

Returns

Promise<TaxServiceRate[]>

the tax rates configured for the shipping option.

Defined in

services/tax-provider.ts:374


getRegionRatesForShipping

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

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

Parameters

NameTypeDescription
optionIdstringthe option id of the shipping method.
regionRegionthe region to get configured rates for.

Returns

Promise<TaxServiceRate[]>

the tax rates configured for the shipping option.

Defined in

services/tax-provider.ts:327


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

NameTypeDescription
shippingMethodShippingMethodthe shipping method to get tax lines for
calculationContextTaxCalculationContextthe calculation context to get tax lines by

Returns

Promise<ShippingMethodTaxLine[]>

the computed tax lines

Defined in

services/tax-provider.ts:185


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

NameTypeDescription
lineItemsLineItem[]the cart or order to get tax lines for
calculationContextTaxCalculationContextthe calculation context to get tax lines by

Returns

Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>

the computed tax lines

Defined in

services/tax-provider.ts:237


list

list(): Promise<TaxProvider[]>

Returns

Promise<TaxProvider[]>

Defined in

services/tax-provider.ts:70


registerInstalledProviders

registerInstalledProviders(providers): Promise<void>

Parameters

NameType
providersstring[]

Returns

Promise<void>

Defined in

services/tax-provider.ts:471


retrieveProvider

retrieveProvider(region): ITaxService

Retrieves the relevant tax provider for the given region.

Parameters

NameTypeDescription
regionRegionthe region to get tax provider for.

Returns

ITaxService

the region specific tax provider

Defined in

services/tax-provider.ts:80


setCache

Private setCache(productId, regionId, value): Promise<void>

Sets the cache results for a set of ids

Parameters

NameTypeDescription
productIdstringthe product id to cache
regionIdstringthe region id to cache
valueTaxServiceRate[]tax rates to cache

Returns

Promise<void>

promise that resolves after the cache has been set

Defined in

services/tax-provider.ts:430


withTransaction

withTransaction(transactionManager): TaxProviderService

Parameters

NameType
transactionManagerEntityManager

Returns

TaxProviderService

Defined in

services/tax-provider.ts:57