TotalsService
A service that calculates total and subtotals for orders, carts etc..
Implements
Constructors
constructor
**new TotalsService**(«destructured»)
Parameters
Properties
__configModule__
Record<string, unknown>__container__
anyRequired__moduleDeclaration__
Record<string, unknown>manager_
EntityManagerRequiredtransactionManager_
undefined | EntityManagerRequiredAccessors
activeManager_
Protected get**activeManager_**(): EntityManager
Returns
EntityManager
EntityManager
EntityManagerRequiredMethods
atomicPhase_
Protected **atomicPhase_**<TypeParameter TResult, TypeParameter 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.
TResult
objectRequiredTError
objectRequiredParameters
work
(transactionManager: EntityManager) => Promise<TResult>RequiredisolationOrErrorHandler
IsolationLevel | (error: TError) => Promise<void | TResult>maybeErrorHandlerOrDontFail
(error: TError) => Promise<void | TResult>Returns
Promise<TResult>
Promise
Promise<TResult>RequiredcalculateDiscount_
**calculateDiscount_**(lineItem, variant, variantPrice, value, discountType): [LineDiscount](/references/services/types/LineDiscount)
Calculates either fixed or percentage discount of a variant
Parameters
variant
stringRequiredvariantPrice
numberRequiredvalue
numberRequiredReturns
LineDiscount
objectRequiredDeprecated
- in favour of DiscountService.calculateDiscountForLineItem
getAllocationItemDiscounts
**getAllocationItemDiscounts**(discount, cart): [LineDiscount](/references/services/types/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
Returns
getAllocationMap
**getAllocationMap**(orderOrCart, options?): Promise<[LineAllocationsMap](/references/services/types/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
orderOrCart
objectRequiredorderOrCart.claims
ClaimOrder[]orderOrCart.discounts
Discount[]orderOrCart.swaps
Swap[]Default: {}
Returns
Promise<LineAllocationsMap>
getCalculationContext
**getCalculationContext**(calculationContextData, options?): Promise<[TaxCalculationContext](/references/services/types/TaxCalculationContext)>
Prepares the calculation context for a tax total calculation.
Parameters
Default: {}
Returns
Promise<TaxCalculationContext>
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
Returns
Promise<number>
Promise
Promise<number>RequiredgetGiftCardTotal
**getGiftCardTotal**(cartOrOrder, opts?): Promise<{ tax_total: number ; total: number }>
Gets the gift card amount on a cart or order.
Parameters
Returns
Promise<{ tax_total: number ; total: number }>
Promise
Promise<{ tax_total: number ; total: number }>RequiredgetGiftCardableAmount
**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
Returns
Promise<number>
Promise
Promise<number>RequiredgetLineDiscounts
**getLineDiscounts**(cartOrOrder, discount?): [LineDiscountAmount](/references/services/types/LineDiscountAmount)[]
Returns the discount amount allocated to the line items of an order.
Parameters
cartOrOrder
objectRequiredcartOrOrder.claims
ClaimOrder[]cartOrOrder.swaps
Swap[]discount
DiscountReturns
getLineItemAdjustmentsTotal
**getLineItemAdjustmentsTotal**(cartOrOrder): number
Parameters
Returns
number
number
numbergetLineItemDiscountAdjustment
**getLineItemDiscountAdjustment**(lineItem, discount): number
Parameters
Returns
number
number
numbergetLineItemRefund
**getLineItemRefund**(order, lineItem): Promise<number>
The amount that can be refunded for a given line item.
Parameters
Returns
Promise<number>
Promise
Promise<number>RequiredgetLineItemTotal
**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
Default: {}
Returns
Promise<number>
Promise
Promise<number>RequiredgetLineItemTotals
**getLineItemTotals**(lineItem, cartOrOrder, options?): Promise<[LineItemTotals](/references/services/types/LineItemTotals-1)>
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
Default: {}
Returns
Promise<LineItemTotals>
getPaidTotal
**getPaidTotal**(order): number
Gets the total payments made on an order
Parameters
Returns
number
number
numbergetRefundTotal
**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
Returns
Promise<number>
Promise
Promise<number>RequiredgetRefundedTotal
**getRefundedTotal**(order): number
Gets the total refund amount for an order.
Parameters
Returns
number
number
numbergetShippingMethodTotals
**getShippingMethodTotals**(shippingMethod, cartOrOrder, opts?): Promise<[ShippingMethodTotals](/references/services/types/ShippingMethodTotals-1)>
Gets the totals breakdown for a shipping method. Fetches tax lines if not already provided.
Parameters
Default: {}
Returns
Promise<ShippingMethodTotals>
getShippingTotal
**getShippingTotal**(cartOrOrder): Promise<number>
Calculates shipping total
Parameters
Returns
Promise<number>
Promise
Promise<number>RequiredgetSubtotal
**getSubtotal**(cartOrOrder, opts?): Promise<number>
Calculates subtotal of a given cart or order.
Parameters
Default: {}
Returns
Promise<number>
Promise
Promise<number>RequiredgetSwapTotal
**getSwapTotal**(order): number
The total paid for swaps. May be negative in case of negative swap difference.
Parameters
Returns
number
number
numbergetTaxTotal
**getTaxTotal**(cartOrOrder, forceTaxes?): Promise<null \| number>
Calculates tax total Currently based on the Danish tax system
Parameters
Returns
Promise<null | number>
Promise
Promise<null | number>RequiredgetTotal
**getTotal**(cartOrOrder, options?): Promise<number>
Calculates total of a given cart or order.
Parameters
Default: {}
Returns
Promise<number>
Promise
Promise<number>Requiredrounded
**rounded**(value): number
Rounds a number using Math.round.
Parameters
value
numberRequiredReturns
number
number
numbershouldRetryTransaction_
Protected **shouldRetryTransaction_**(err): boolean
Parameters
err
Record<string, unknown> | { code: string }RequiredReturns
boolean
boolean
booleanwithTransaction
**withTransaction**(transactionManager?): [TotalsService](/references/services/classes/TotalsService)
Parameters
transactionManager
EntityManager