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

Class: TotalsService

Hierarchy

• "medusa-interfaces"

  ↳ TotalsService

Constructors

constructor

• new TotalsService(__namedParameters)

Parameters

Name	Type
__namedParameters	TotalsServiceProps

Overrides

BaseService.constructor

Defined in

services/totals.ts:90

Properties

taxCalculationStrategy_

• Private taxCalculationStrategy_: ITaxCalculationStrategy

Defined in

services/totals.ts:88

---

taxProviderService_

• Private taxProviderService_: TaxProviderService

Defined in

services/totals.ts:87

Methods

calculateDiscount_

▸ calculateDiscount_(lineItem, variant, variantPrice, value, discountType): LineDiscount

Parameters

Name	Type	Description
lineItem	LineItem
variant	string
variantPrice	number
value	number
discountType	DiscountRuleType

Returns

LineDiscount

Defined in

services/totals.ts:553

---

getAllocationItemDiscounts

▸ getAllocationItemDiscounts(discount, cart): LineDiscount[]

Parameters

Name	Type	Description
discount	Discount
cart	Order | Cart

Returns

LineDiscount[]

Defined in

services/totals.ts:595

---

getAllocationMap

▸ getAllocationMap(orderOrCart, options?): LineAllocationsMap

Parameters

Name	Type	Description
orderOrCart	Order | Cart
options	AllocationMapOptions

Returns

LineAllocationsMap

Defined in

services/totals.ts:376

---

getCalculationContext

▸ getCalculationContext(cartOrOrder, options?): TaxCalculationContext

Parameters

Name	Type	Description
cartOrOrder	Order | Cart
options	CalculationContextOptions

Returns

TaxCalculationContext

Defined in

services/totals.ts:959

---

getDiscountTotal

▸ getDiscountTotal(cartOrOrder): number

Parameters

Name	Type	Description
cartOrOrder	Order | Cart

Returns

number

Defined in

services/totals.ts:925

---

getGiftCardTotal

▸ getGiftCardTotal(cartOrOrder): Object

Parameters

Name	Type	Description
cartOrOrder	Order | Cart

Returns

Object

Name	Type
tax_total	number
total	number

Defined in

services/totals.ts:853

---

getGiftCardableAmount

▸ getGiftCardableAmount(cartOrOrder): Promise<number>

Parameters

Name	Type	Description
cartOrOrder	Order | Cart

Returns

Promise<number>

Defined in

services/totals.ts:838

---

getLineDiscounts

▸ getLineDiscounts(cartOrOrder, discount): LineDiscountAmount[]

Parameters

Name	Type	Description
cartOrOrder	Order | Cart
discount	Discount

Returns

LineDiscountAmount[]

Defined in

services/totals.ts:646

---

getLineItemAdjustmentsTotal

▸ getLineItemAdjustmentsTotal(cartOrOrder): number

Parameters

Name	Type
cartOrOrder	Order | Cart

Returns

number

Defined in

services/totals.ts:623

---

getLineItemDiscountAdjustment

▸ getLineItemDiscountAdjustment(lineItem, discount): number

Parameters

Name	Type
lineItem	LineItem
discount	Discount

Returns

number

Defined in

services/totals.ts:608

---

getLineItemRefund

▸ getLineItemRefund(order, lineItem): number

Parameters

Name	Type	Description
order	Order
lineItem	LineItem

Returns

number

Defined in

services/totals.ts:468

---

getLineItemTotal

▸ getLineItemTotal(lineItem, cartOrOrder, options?): Promise<number>

Parameters

Name	Type	Description
lineItem	LineItem
cartOrOrder	Order | Cart
options	GetLineItemTotalOptions

Returns

Promise<number>

Defined in

services/totals.ts:807

---

getLineItemTotals

▸ getLineItemTotals(lineItem, cartOrOrder, options?): Promise<LineItemTotals>

Parameters

Name	Type	Description
lineItem	LineItem
cartOrOrder	Order | Cart
options	LineItemTotalsOptions

Returns

Promise<LineItemTotals>

Defined in

services/totals.ts:692

---

getPaidTotal

▸ getPaidTotal(order): number

Parameters

Name	Type	Description
order	Order

Returns

number

Defined in

services/totals.ts:129

---

getRefundTotal

▸ getRefundTotal(order, lineItems): number

Parameters

Name	Type	Description
order	Order
lineItems	LineItem[]

Returns

number

Defined in

services/totals.ts:512

---

getRefundedTotal

▸ getRefundedTotal(order): number

Parameters

Name	Type	Description
order	Order

Returns

number

Defined in

services/totals.ts:453

---

getShippingMethodTotals

▸ getShippingMethodTotals(shippingMethod, cartOrOrder, opts?): Promise<ShippingMethodTotals>

Parameters

Name	Type	Description
shippingMethod	ShippingMethod
cartOrOrder	Order | Cart
opts	GetShippingMethodTotalsOptions

Returns

Promise<ShippingMethodTotals>

Defined in

services/totals.ts:163

---

getShippingTotal

▸ getShippingTotal(cartOrOrder): number

Parameters

Name	Type	Description
cartOrOrder	Order | Cart

Returns

number

Defined in

services/totals.ts:271

---

getSubtotal

▸ getSubtotal(cartOrOrder, opts?): number

Parameters

Name	Type	Description
cartOrOrder	Order | Cart
opts	SubtotalOptions

Returns

number

Defined in

services/totals.ts:247

---

getSwapTotal

▸ getSwapTotal(order): number

Parameters

Name	Type	Description
order	Order

Returns

number

Defined in

services/totals.ts:144

---

getTaxTotal

▸ getTaxTotal(cartOrOrder, forceTaxes?): Promise<null | number>

Parameters

Name	Type	Default value	Description
cartOrOrder	Order | Cart	undefined
forceTaxes	boolean	false

Returns

Promise<null | number>

Defined in

services/totals.ts:286

---

getTotal

▸ getTotal(cartOrOrder, options?): Promise<number>

Parameters

Name	Type	Description
cartOrOrder	Order | Cart
options	GetTotalsOptions

Returns

Promise<number>

Defined in

services/totals.ts:106

---

rounded

▸ rounded(value): number

Parameters

Name	Type	Description
value	number

Returns

number

Defined in

services/totals.ts:989