Skip to main content

Class: TotalsService

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

implements {BaseService}

Hierarchy

  • "medusa-interfaces"

    TotalsService

Constructors

constructor

new TotalsService(__namedParameters)

Parameters

NameType
__namedParametersTotalsServiceProps

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

Calculates either fixed or percentage discount of a variant

Parameters

NameTypeDescription
lineItemLineItemid of line item
variantstringid of variant in line item
variantPricenumberprice of the variant based on region
valuenumberdiscount value
discountTypeDiscountRuleTypethe type of discount (fixed or percentage)

Returns

LineDiscount

triples of lineitem, variant and applied discount

Defined in

services/totals.ts:545


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

NameTypeDescription
discountDiscountthe discount to which we do the calculation
cartCart | Orderthe cart to calculate discounts for

Returns

LineDiscount[]

array of triples of lineitem, variant and applied discount

Defined in

services/totals.ts:587


getAllocationMap

getAllocationMap(orderOrCart, options?): 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

NameTypeDescription
orderOrCartCart | Orderthe order or cart to get an allocation map for
optionsAllocationMapOptionscontrols what should be included in allocation map

Returns

LineAllocationsMap

the allocation map for the line items in the cart or order.

Defined in

services/totals.ts:368


getCalculationContext

getCalculationContext(cartOrOrder, options?): TaxCalculationContext

Prepares the calculation context for a tax total calculation.

Parameters

NameTypeDescription
cartOrOrderCart | Orderthe cart or order to get the calculation context for
optionsCalculationContextOptionsoptions to gather context by

Returns

TaxCalculationContext

the tax calculation context

Defined in

services/totals.ts:892


getDiscountTotal

getDiscountTotal(cartOrOrder): number

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

Parameters

NameTypeDescription
cartOrOrderCart | Orderthe cart or order to calculate discounts for

Returns

number

the total discounts amount

Defined in

services/totals.ts:858


getGiftCardTotal

getGiftCardTotal(cartOrOrder): number

Gets the gift card amount on a cart or order.

Parameters

NameTypeDescription
cartOrOrderCart | Orderthe cart or order to get gift card amount for

Returns

number

the gift card amount applied to the cart or order

Defined in

services/totals.ts:830


getLineDiscounts

getLineDiscounts(cartOrOrder, discount): LineDiscountAmount[]

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

Parameters

NameTypeDescription
cartOrOrderCart | Orderthe cart or order to get line discount allocations for
discountDiscountthe discount to use as context for the calculation

Returns

LineDiscountAmount[]

the allocations that the discount has on the items in the cart or order

Defined in

services/totals.ts:638


getLineItemAdjustmentsTotal

getLineItemAdjustmentsTotal(cartOrOrder): number

Parameters

NameType
cartOrOrderCart | Order

Returns

number

Defined in

services/totals.ts:615


getLineItemDiscountAdjustment

getLineItemDiscountAdjustment(lineItem, discount): number

Parameters

NameType
lineItemLineItem
discountDiscount

Returns

number

Defined in

services/totals.ts:600


getLineItemRefund

getLineItemRefund(order, lineItem): number

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

Parameters

NameTypeDescription
orderOrderorder to use as context for the calculation
lineItemLineItemthe line item to calculate the refund amount for.

Returns

number

the line item refund amount.

Defined in

services/totals.ts:460


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

NameTypeDescription
lineItemLineItemthe line item to calculate a total for
cartOrOrderCart | Orderthe cart or order to use as context for the calculation
optionsGetLineItemTotalOptionsthe options to use for the calculation

Returns

Promise<number>

the line item total

Defined in

services/totals.ts:800


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

NameTypeDescription
lineItemLineItemthe line item to calculate totals for
cartOrOrderCart | Orderthe cart or order to use as context for the calculation
optionsLineItemTotalsOptionsthe options to evaluate the line item totals for

Returns

Promise<LineItemTotals>

the breakdown of the line item totals

Defined in

services/totals.ts:684


getPaidTotal

getPaidTotal(order): number

Gets the total payments made on an order

Parameters

NameTypeDescription
orderOrderthe order to calculate paid amount for

Returns

number

the total paid amount

Defined in

services/totals.ts:125


getRefundTotal

getRefundTotal(order, lineItems): 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

NameTypeDescription
orderOrdercart or order to calculate subtotal for
lineItemsLineItem[]the line items to calculate refund total for

Returns

number

the calculated subtotal

Defined in

services/totals.ts:504


getRefundedTotal

getRefundedTotal(order): number

Gets the total refund amount for an order.

Parameters

NameTypeDescription
orderOrderthe order to get total refund amount for.

Returns

number

the total refunded amount for an order.

Defined in

services/totals.ts:445


getShippingMethodTotals

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

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

Parameters

NameTypeDescription
shippingMethodShippingMethodthe shipping method to get totals breakdown for.
cartOrOrderCart | Orderthe cart or order to use as context for the breakdown
optsGetShippingMethodTotalsOptionsoptions for what should be included

Returns

Promise<ShippingMethodTotals>

An object that breaks down the totals for the shipping method

Defined in

services/totals.ts:159


getShippingTotal

getShippingTotal(cartOrOrder): number

Calculates shipping total

Parameters

NameTypeDescription
cartOrOrderCart | Ordercart or order to calculate subtotal for

Returns

number

shipping total

Defined in

services/totals.ts:267


getSubtotal

getSubtotal(cartOrOrder, opts?): number

Calculates subtotal of a given cart or order.

Parameters

NameTypeDescription
cartOrOrderCart | Ordercart or order to calculate subtotal for
optsSubtotalOptionsoptions

Returns

number

the calculated subtotal

Defined in

services/totals.ts:243


getSwapTotal

getSwapTotal(order): number

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

Parameters

NameTypeDescription
orderOrderthe order to calculate swap total for

Returns

number

the swap total

Defined in

services/totals.ts:140


getTaxTotal

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

Calculates tax total Currently based on the Danish tax system

Parameters

NameTypeDefault valueDescription
cartOrOrderCart | Orderundefinedcart or order to calculate tax total for
forceTaxesbooleanfalsewhether taxes should be calculated regardless of region settings

Returns

Promise<null | number>

tax total

Defined in

services/totals.ts:282


getTotal

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

Calculates subtotal of a given cart or order.

Parameters

NameTypeDescription
cartOrOrderCart | Orderobject to calculate total for
optionsGetTotalsOptionsoptions to calculate by

Returns

Promise<number>

the calculated subtotal

Defined in

services/totals.ts:106


rounded

rounded(value): number

Rounds a number using Math.round.

Parameters

NameTypeDescription
valuenumberthe value to round

Returns

number

the rounded value

Defined in

services/totals.ts:922