TotalsService
A service that calculates total and subtotals for orders, carts etc..
Implements
constructor
Parameters
__namedParameters
TotalsServicePropsRequiredProperties
manager_
EntityManagerRequiredtransactionManager_
undefined | EntityManagerRequired__container__
anyRequiredfeatureFlagRouter_
FlagRouterRequired__configModule__
Record<string, unknown>__moduleDeclaration__
Record<string, unknown>Accessors
activeManager_
Returns
EntityManager
EntityManagerRequiredMethods
withTransaction
Parameters
transactionManager
EntityManagerReturns
this
thisRequiredshouldRetryTransaction_
Parameters
err
Record<string, unknown> | objectRequiredReturns
boolean
booleanRequiredatomicPhase_
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.
Type Parameters
TResult
objectRequiredTError
objectRequiredParameters
work
(transactionManager: EntityManager) => Promise<TResult>RequiredisolationOrErrorHandler
IsolationLevel | (error: TError) => Promise<void | TResult>maybeErrorHandlerOrDontFail
(error: TError) => Promise<void | TResult>Returns
Promise
Promise<TResult>RequiredgetTotal
Calculates total of a given cart or order.
Parameters
Returns
Promise
Promise<number>RequiredgetPaidTotal
Gets the total payments made on an order
Parameters
Returns
number
numberRequiredgetSwapTotal
The total paid for swaps. May be negative in case of negative swap difference.
Parameters
Returns
number
numberRequiredgetShippingMethodTotals
Gets the totals breakdown for a shipping method. Fetches tax lines if not already provided.
Parameters
opts
GetShippingMethodTotalsOptionsRequiredDefault: {}
Returns
Promise
Promise<ShippingMethodTotals>RequiredgetSubtotal
Calculates subtotal of a given cart or order.
Parameters
Returns
Promise
Promise<number>RequiredgetShippingTotal
Calculates shipping total
Parameters
Returns
Promise
Promise<number>RequiredgetTaxTotal
Calculates tax total Currently based on the Danish tax system
Parameters
Returns
Promise
Promise<null | number>RequiredgetAllocationMap
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
objectRequiredoptions
AllocationMapOptionsRequiredDefault: {}
orderOrCart.discounts
Discount[]orderOrCart.swaps
Swap[]orderOrCart.claims
ClaimOrder[]Returns
Promise
Promise<LineAllocationsMap>RequiredgetRefundedTotal
Gets the total refund amount for an order.
Parameters
Returns
number
numberRequiredgetLineItemRefund
The amount that can be refunded for a given line item.
Parameters
Returns
Promise
Promise<number>RequiredgetRefundTotal
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
Promise<number>RequiredcalculateDiscount_
Calculates either fixed or percentage discount of a variant
Parameters
variant
stringRequiredvariantPrice
numberRequiredvalue
numberRequiredReturns
LineDiscount
LineDiscountRequiredDeprecated
- in favour of DiscountService.calculateDiscountForLineItem
getAllocationItemDiscounts
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
LineDiscount[]
LineDiscount[]RequiredgetLineItemDiscountAdjustment
Parameters
Returns
number
numberRequiredgetLineItemAdjustmentsTotal
Parameters
Returns
number
numberRequiredgetLineDiscounts
Returns the discount amount allocated to the line items of an order.
Parameters
cartOrOrder
objectRequiredcartOrOrder.swaps
Swap[]cartOrOrder.claims
ClaimOrder[]discount
DiscountReturns
LineDiscountAmount[]
LineDiscountAmount[]RequiredgetLineItemTotals
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
Returns
Promise
Promise<LineItemTotals>RequiredgetLineItemTotal
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
Returns
Promise
Promise<number>RequiredgetGiftCardableAmount
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
Promise<number>RequiredgetGiftCardTotal
Gets the gift card amount on a cart or order.
Parameters
Returns
Promise
Promise<object>RequiredgetDiscountTotal
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
Promise<number>RequiredgetCalculationContext
Prepares the calculation context for a tax total calculation.
Parameters
calculationContextData
CalculationContextDataRequiredoptions
CalculationContextOptionsRequiredDefault: {}
Returns
rounded
Rounds a number using Math.round.
Parameters
value
numberRequiredReturns
number
numberRequired