TotalsService

A service that calculates total and subtotals for orders, carts etc..

Implements

Hierarchy

• TransactionBaseService

  ↳ TotalsService

Constructors

constructor

new TotalsService(«destructured»)

Parameters

Name
«destructured»

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/totals.ts:112

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/totals.ts:110

---

manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5

---

newTotalsService_

Protected Readonly newTotalsService_: NewTotalsService

Defined in

medusa/src/services/totals.ts:108

---

taxCalculationStrategy_

Protected Readonly taxCalculationStrategy_: ITaxCalculationStrategy

Defined in

medusa/src/services/totals.ts:109

---

taxProviderService_

Protected Readonly taxProviderService_: TaxProviderService

Defined in

medusa/src/services/totals.ts:107

---

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

-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.

Name
TResult
TError

Parameters

Name	Description
work	(transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

-Promise: the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56

---

calculateDiscount_

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

Calculates either fixed or percentage discount of a variant

Parameters

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

Returns

LineDiscount

Deprecated

• in favour of DiscountService.calculateDiscountForLineItem

Defined in

medusa/src/services/totals.ts:627

---

getAllocationItemDiscounts

getAllocationItemDiscounts(discount, cart): LineDiscount[]

If the rule of a discount has allocation="item", then we need to calculate discount on each item in the cart. Furthermore, we need to make sure to only apply the discount on valid variants. And finally we return ether an array of percentages discounts or fixed discounts alongside the variant on which the discount was applied.

Parameters

Name	Description
discount	Discount
cart	Order | Cart

Returns

LineDiscount[]

-LineDiscount[]: array of triples of lineitem, variant and applied discount

Defined in

medusa/src/services/totals.ts:669

---

getAllocationMap

getAllocationMap(orderOrCart, options?): Promise<LineAllocationsMap>

Gets a map of discounts and gift cards that apply to line items in an order. The function calculates the amount of a discount or gift card that applies to a specific line item.

Parameters

Name	Description
orderOrCart	object
orderOrCart.claims?	ClaimOrder[]
orderOrCart.discounts?	Discount[]
orderOrCart.items	LineItem[]
orderOrCart.swaps?	Swap[]
options	AllocationMapOptions

Returns

Promise<LineAllocationsMap>

-Promise: the allocation map for the line items in the cart or order.

Defined in

medusa/src/services/totals.ts:435

---

getCalculationContext

getCalculationContext(calculationContextData, options?): Promise<TaxCalculationContext>

Prepares the calculation context for a tax total calculation.

Parameters

Name	Description
calculationContextData	CalculationContextData
options	CalculationContextOptions

Returns

Promise<TaxCalculationContext>

-Promise: the tax calculation context

Defined in

medusa/src/services/totals.ts:1028

---

getDiscountTotal

getDiscountTotal(cartOrOrder): Promise<number>

Calculates the total discount amount for each of the different supported discount types. If discounts aren't present or invalid returns 0.

Parameters

Name	Description
cartOrOrder	Order | Cart

Returns

Promise<number>

-Promise: the total discounts amount -number: (optional)

Defined in

medusa/src/services/totals.ts:1006

---

getGiftCardTotal

getGiftCardTotal(cartOrOrder, opts?): Promise<{ tax_total: number ; total: number }>

Gets the gift card amount on a cart or order.

Parameters

Name	Description
cartOrOrder	Order | Cart
opts	object
opts.gift_cardable?	number

Returns

Promise<{ tax_total: number ; total: number }>

-Promise: the gift card amount applied to the cart or order -object: (optional)

Defined in

medusa/src/services/totals.ts:975

---

getGiftCardableAmount

getGiftCardableAmount(cartOrOrder): Promise<number>

Gets the amount that can be gift carded on a cart. In regions where gift cards are taxable this amount should exclude taxes.

Parameters

Name	Description
cartOrOrder	Order | Cart

Returns

Promise<number>

-Promise: the gift card amount applied to the cart or order -number: (optional)

Defined in

medusa/src/services/totals.ts:958

---

getLineDiscounts

getLineDiscounts(cartOrOrder, discount?): LineDiscountAmount[]

Returns the discount amount allocated to the line items of an order.

Parameters

Name	Description
cartOrOrder	object
cartOrOrder.claims?	ClaimOrder[]
cartOrOrder.items	LineItem[]
cartOrOrder.swaps?	Swap[]
discount?	Discount

Returns

LineDiscountAmount[]

-LineDiscountAmount[]: the allocations that the discount has on the items in the cart or order

Defined in

medusa/src/services/totals.ts:720

---

getLineItemAdjustmentsTotal

getLineItemAdjustmentsTotal(cartOrOrder): number

Parameters

Name
cartOrOrder

Returns

number

-number: (optional)

Defined in

medusa/src/services/totals.ts:697

---

getLineItemDiscountAdjustment

getLineItemDiscountAdjustment(lineItem, discount): number

Parameters

Name
lineItem
discount

Returns

number

-number: (optional)

Defined in

medusa/src/services/totals.ts:682

---

getLineItemRefund

getLineItemRefund(order, lineItem): Promise<number>

The amount that can be refunded for a given line item.

Parameters

Name	Description
order	Order
lineItem	LineItem

Returns

Promise<number>

-Promise: the line item refund amount. -number: (optional)

Defined in

medusa/src/services/totals.ts:504

---

getLineItemTotal

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

Gets a total for a line item. The total can take gift cards, discounts and taxes into account. This can be controlled through the options.

Parameters

Name	Description
lineItem	LineItem
cartOrOrder	Order | Cart
options	GetLineItemTotalOptions

Returns

Promise<number>

-Promise: the line item total -number: (optional)

Defined in

medusa/src/services/totals.ts:931

---

getLineItemTotals

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

Breaks down the totals related to a line item; these are the subtotal, the amount of discount applied to the line item, the amount of a gift card applied to a line item and the amount of tax applied to a line item.

Parameters

Name	Description
lineItem	LineItem
cartOrOrder	Order | Cart
options	LineItemTotalsOptions

Returns

Promise<LineItemTotals>

-Promise: the breakdown of the line item totals

Defined in

medusa/src/services/totals.ts:776

---

getPaidTotal

getPaidTotal(order): number

Gets the total payments made on an order

Parameters

Name	Description
order	Order

Returns

number

-number: (optional) the total paid amount

Defined in

medusa/src/services/totals.ts:157

---

getRefundTotal

getRefundTotal(order, lineItems): Promise<number>

Calculates refund total of line items. If any of the items to return have been discounted, we need to apply the discount again before refunding them.

Parameters

Name	Description
order	Order
lineItems	LineItem[]

Returns

Promise<number>

-Promise: the calculated subtotal -number: (optional)

Defined in

medusa/src/services/totals.ts:583

---

getRefundedTotal

getRefundedTotal(order): number

Gets the total refund amount for an order.

Parameters

Name	Description
order	Order

Returns

number

-number: (optional) the total refunded amount for an order.

Defined in

medusa/src/services/totals.ts:489

---

getShippingMethodTotals

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

Gets the totals breakdown for a shipping method. Fetches tax lines if not already provided.

Parameters

Name	Description
shippingMethod	ShippingMethod
cartOrOrder	Order | Cart
opts	GetShippingMethodTotalsOptions

Returns

Promise<ShippingMethodTotals>

-Promise: An object that breaks down the totals for the shipping method

Defined in

medusa/src/services/totals.ts:191

---

getShippingTotal

getShippingTotal(cartOrOrder): Promise<number>

Calculates shipping total

Parameters

Name	Description
cartOrOrder	Order | Cart

Returns

Promise<number>

-Promise: shipping total -number: (optional)

Defined in

medusa/src/services/totals.ts:319

---

getSubtotal

getSubtotal(cartOrOrder, opts?): Promise<number>

Calculates subtotal of a given cart or order.

Parameters

Name	Description
cartOrOrder	Order | Cart
opts	SubtotalOptions

Returns

Promise<number>

-Promise: the calculated subtotal -number: (optional)

Defined in

medusa/src/services/totals.ts:283

---

getSwapTotal

getSwapTotal(order): number

The total paid for swaps. May be negative in case of negative swap difference.

Parameters

Name	Description
order	Order

Returns

number

-number: (optional) the swap total

Defined in

medusa/src/services/totals.ts:172

---

getTaxTotal

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

Calculates tax total Currently based on the Danish tax system

Parameters

Name	Default value	Description
cartOrOrder	Order | Cart	cart or order to calculate tax total for
forceTaxes	boolean	false

Returns

Promise<null | number>

-Promise: tax total -`null | number`: (optional)

Defined in

medusa/src/services/totals.ts:346

---

getTotal

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

Calculates total of a given cart or order.

Parameters

Name	Description
cartOrOrder	Order | Cart
options	GetTotalsOptions

Returns

Promise<number>

-Promise: the calculated subtotal -number: (optional)

Defined in

medusa/src/services/totals.ts:134

---

rounded

rounded(value): number

Rounds a number using Math.round.

Parameters

Name	Description
value	number

Returns

number

-number: (optional) the rounded value

Defined in

medusa/src/services/totals.ts:1058

---

shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

Name
err

Returns

boolean

-boolean: (optional)

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37

---

withTransaction

withTransaction(transactionManager?): TotalsService

Parameters

Name
transactionManager?

Returns

TotalsService

-TotalsService:

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20