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

Class: TaxRateService

Hierarchy

• "medusa-interfaces"

  ↳ TaxRateService

Constructors

constructor

• new TaxRateService(__namedParameters)

Parameters

Name	Type
__namedParameters	Object

Overrides

BaseService.constructor

Defined in

services/tax-rate.ts:27

Properties

manager_

• Private manager_: EntityManager

Defined in

services/tax-rate.ts:21

---

productService_

• Private productService_: ProductService

Defined in

services/tax-rate.ts:22

---

productTypeService_

• Private productTypeService_: ProductTypeService

Defined in

services/tax-rate.ts:23

---

shippingOptionService_

• Private shippingOptionService_: ShippingOptionService

Defined in

services/tax-rate.ts:24

---

taxRateRepository_

• Private taxRateRepository_: typeof TaxRateRepository

Defined in

services/tax-rate.ts:25

Methods

addToProduct

▸ addToProduct(id, productIds, replace?): Promise<ProductTaxRate | ProductTaxRate[]>

Parameters

Name	Type	Default value
id	string	undefined
productIds	string | string[]	undefined
replace	boolean	false

Returns

Promise<ProductTaxRate | ProductTaxRate[]>

Defined in

services/tax-rate.ts:197

---

addToProductType

▸ addToProductType(id, productTypeIds, replace?): Promise<ProductTypeTaxRate[]>

Parameters

Name	Type	Default value
id	string	undefined
productTypeIds	string | string[]	undefined
replace	boolean	false

Returns

Promise<ProductTypeTaxRate[]>

Defined in

services/tax-rate.ts:233

---

addToShippingOption

▸ addToShippingOption(id, optionIds, replace?): Promise<ShippingTaxRate>

Parameters

Name	Type	Default value
id	string	undefined
optionIds	string | string[]	undefined
replace	boolean	false

Returns

Promise<ShippingTaxRate>

Defined in

services/tax-rate.ts:273

---

create

▸ create(data): Promise<TaxRate>

Parameters

Name	Type
data	CreateTaxRateInput

Returns

Promise<TaxRate>

Defined in

services/tax-rate.ts:104

---

delete

▸ delete(id): Promise<void>

Parameters

Name	Type
id	string | string[]

Returns

Promise<void>

Defined in

services/tax-rate.ts:135

---

list

▸ list(selector, config?): Promise<TaxRate[]>

Parameters

Name	Type
selector	FilterableTaxRateProps
config	FindConfig<TaxRate>

Returns

Promise<TaxRate[]>

Defined in

services/tax-rate.ts:62

---

listAndCount

▸ listAndCount(selector, config?): Promise<[TaxRate[], number]>

Parameters

Name	Type
selector	FilterableTaxRateProps
config	FindConfig<TaxRate>

Returns

Promise<[TaxRate[], number]>

Defined in

services/tax-rate.ts:73

---

listByProduct

▸ listByProduct(productId, config): Promise<TaxRate[]>

Parameters

Name	Type
productId	string
config	TaxRateListByConfig

Returns

Promise<TaxRate[]>

Defined in

services/tax-rate.ts:321

---

listByShippingOption

▸ listByShippingOption(shippingOptionId, config): Promise<TaxRate[]>

Parameters

Name	Type
shippingOptionId	string
config	TaxRateListByConfig

Returns

Promise<TaxRate[]>

Defined in

services/tax-rate.ts:332

---

removeFromProduct

▸ removeFromProduct(id, productIds): Promise<void>

Parameters

Name	Type
id	string
productIds	string | string[]

Returns

Promise<void>

Defined in

services/tax-rate.ts:143

---

removeFromProductType

▸ removeFromProductType(id, typeIds): Promise<void>

Parameters

Name	Type
id	string
typeIds	string | string[]

Returns

Promise<void>

Defined in

services/tax-rate.ts:161

---

removeFromShippingOption

▸ removeFromShippingOption(id, optionIds): Promise<void>

Parameters

Name	Type
id	string
optionIds	string | string[]

Returns

Promise<void>

Defined in

services/tax-rate.ts:179

---

retrieve

▸ retrieve(id, config?): Promise<TaxRate>

Parameters

Name	Type
id	string
config	FindConfig<TaxRate>

Returns

Promise<TaxRate>

Defined in

services/tax-rate.ts:84

---

update

▸ update(id, data): Promise<TaxRate>

Parameters

Name	Type
id	string
data	UpdateTaxRateInput

Returns

Promise<TaxRate>

Defined in

services/tax-rate.ts:120

---

withTransaction

▸ withTransaction(transactionManager): TaxRateService

Parameters

Name	Type
transactionManager	EntityManager

Returns

TaxRateService

Defined in

services/tax-rate.ts:43