Skip to main content

Class: CartService

Hierarchy

Constructors

constructor

new CartService(__namedParameters)

Parameters

NameType
__namedParametersInjectedDependencies

Overrides

TransactionBaseService<CartService\>.constructor

Defined in

services/cart.ts:106

Properties

addressRepository_

Protected Readonly addressRepository_: typeof AddressRepository

Defined in

services/cart.ts:86


cartRepository_

Protected Readonly cartRepository_: typeof CartRepository

Defined in

services/cart.ts:85


configModule

Protected Optional Readonly configModule: Record<string, unknown>

Inherited from

TransactionBaseService.configModule


container

Protected Readonly container: unknown

Inherited from

TransactionBaseService.container


customShippingOptionService_

Protected Readonly customShippingOptionService_: CustomShippingOptionService

Defined in

services/cart.ts:102


customerService_

Protected Readonly customerService_: CustomerService

Defined in

services/cart.ts:95


discountService_

Protected Readonly discountService_: DiscountService

Defined in

services/cart.ts:97


eventBus_

Protected Readonly eventBus_: EventBusService

Defined in

services/cart.ts:89


giftCardService_

Protected Readonly giftCardService_: GiftCardService

Defined in

services/cart.ts:98


inventoryService_

Protected Readonly inventoryService_: InventoryService

Defined in

services/cart.ts:101


lineItemAdjustmentService_

Protected Readonly lineItemAdjustmentService_: LineItemAdjustmentService

Defined in

services/cart.ts:104


lineItemRepository_

Protected Readonly lineItemRepository_: typeof LineItemRepository

Defined in

services/cart.ts:88


lineItemService_

Protected Readonly lineItemService_: LineItemService

Defined in

services/cart.ts:93


manager_

Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

services/cart.ts:81


paymentProviderService_

Protected Readonly paymentProviderService_: PaymentProviderService

Defined in

services/cart.ts:94


paymentSessionRepository_

Protected Readonly paymentSessionRepository_: typeof PaymentSessionRepository

Defined in

services/cart.ts:87


priceSelectionStrategy_

Protected Readonly priceSelectionStrategy_: IPriceSelectionStrategy

Defined in

services/cart.ts:103


productService_

Protected Readonly productService_: ProductService

Defined in

services/cart.ts:91


productVariantService_

Protected Readonly productVariantService_: ProductVariantService

Defined in

services/cart.ts:90


regionService_

Protected Readonly regionService_: RegionService

Defined in

services/cart.ts:92


shippingMethodRepository_

Protected Readonly shippingMethodRepository_: typeof ShippingMethodRepository

Defined in

services/cart.ts:84


shippingOptionService_

Protected Readonly shippingOptionService_: ShippingOptionService

Defined in

services/cart.ts:96


taxProviderService_

Protected Readonly taxProviderService_: TaxProviderService

Defined in

services/cart.ts:99


totalsService_

Protected Readonly totalsService_: TotalsService

Defined in

services/cart.ts:100


transactionManager_

Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

services/cart.ts:82


Events

Static Readonly Events: Object

Type declaration

NameType
CREATEDstring
CUSTOMER_UPDATEDstring
UPDATEDstring

Defined in

services/cart.ts:75

Methods

addLineItem

addLineItem(cartId, lineItem): Promise<Cart>

Adds a line item to the cart.

Parameters

NameTypeDescription
cartIdstringthe id of the cart that we will add to
lineItemLineItemthe line item to add.

Returns

Promise<Cart>

the result of the update operation

Defined in

services/cart.ts:528


addShippingMethod

addShippingMethod(cartId, optionId, data?): Promise<Cart>

Adds the shipping method to the list of shipping methods associated with the cart. Shipping Methods are the ways that an order is shipped, whereas a Shipping Option is a possible way to ship an order. Shipping Methods may also have additional details in the data field such as an id for a package shop.

Parameters

NameTypeDescription
cartIdstringthe id of the cart to add shipping method to
optionIdstringid of shipping option to add as valid method
dataRecord<string, unknown>the fulmillment data for the method

Returns

Promise<Cart>

the result of the update operation

Defined in

services/cart.ts:1522


adjustFreeShipping_

Protected adjustFreeShipping_(cart, shouldAdd): Promise<void>

Ensures shipping total on cart is correct in regards to a potential free shipping discount If a free shipping is present, we set shipping methods price to 0 if a free shipping was present, we set shipping methods to original amount

Parameters

NameTypeDescription
cartCartthe the cart to adjust free shipping for
shouldAddbooleanflag to indicate, if we should add or remove

Returns

Promise<void>

void

Defined in

services/cart.ts:680


applyDiscount

applyDiscount(cart, discountCode): Promise<void>

Updates the cart's discounts. If discount besides free shipping is already applied, this will be overwritten Throws if discount regions does not include the cart region

Parameters

NameTypeDescription
cartCartthe cart to update
discountCodestringthe discount code

Returns

Promise<void>

the result of the update operation

Defined in

services/cart.ts:1044


applyGiftCard_

Protected applyGiftCard_(cart, code): Promise<void>

Parameters

NameType
cartCart
codestring

Returns

Promise<void>

Defined in

services/cart.ts:1008


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.

Type parameters

Name
TResult
TError

Parameters

NameTypeDescription
work(transactionManager: EntityManager) => Promise<TResult>the transactional work to be done
isolationOrErrorHandler?IsolationLevel | (error: TError) => Promise<void | TResult>the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?(error: TError) => Promise<void | TResult>Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

interfaces/transaction-base-service.ts:53


authorizePayment

authorizePayment(cartId, context?): Promise<Cart>

Authorizes a payment for a cart. Will authorize with chosen payment provider. This will return a payment object, that we will use to update our cart payment with. Additionally, if the payment does not require more or fails, we will set the payment on the cart.

Parameters

NameTypeDescription
cartIdstringthe id of the cart to authorize payment for
contextRecord<string, unknown>object containing whatever is relevant for authorizing the payment with the payment provider. As an example, this could be IP address or similar for fraud handling.

Returns

Promise<Cart>

the resulting cart

Defined in

services/cart.ts:1183


create

create(data): Promise<Cart>

Creates a cart.

Parameters

NameTypeDescription
dataCartCreatePropsthe data to create the cart with

Returns

Promise<Cart>

the result of the create operation

Defined in

services/cart.ts:329


createOrFetchUserFromEmail_

Protected createOrFetchUserFromEmail_(email): Promise<Customer>

Creates or fetches a user based on an email.

Parameters

NameTypeDescription
emailstringthe email to use

Returns

Promise<Customer>

the resultign customer object

Defined in

services/cart.ts:886


createTaxLines

createTaxLines(id): Promise<Cart>

Parameters

NameType
idstring

Returns

Promise<Cart>

Defined in

services/cart.ts:1919


decorateTotals_

Protected decorateTotals_(cart, totalsToSelect, options?): Promise<Cart>

Parameters

NameType
cartCart
totalsToSelectTotalField[]
optionsTotalsConfig

Returns

Promise<Cart>

Defined in

services/cart.ts:207


delete

delete(cartId): Promise<Cart>

Deletes a cart from the database. Completed carts cannot be deleted.

Parameters

NameTypeDescription
cartIdstringthe id of the cart to delete

Returns

Promise<Cart>

the deleted cart or undefined if the cart was not found.

Defined in

services/cart.ts:1834


deleteMetadata

deleteMetadata(cartId, key): Promise<Cart>

Dedicated method to delete metadata for a cart.

Parameters

NameTypeDescription
cartIdstringthe cart to delete metadata from.
keystringkey for metadata field

Returns

Promise<Cart>

resolves to the updated result.

Defined in

services/cart.ts:1972


deletePaymentSession

deletePaymentSession(cartId, providerId): Promise<Cart>

Removes a payment session from the cart.

Parameters

NameTypeDescription
cartIdstringthe id of the cart to remove from
providerIdstringthe id of the provider whoose payment session should be removed.

Returns

Promise<Cart>

the resulting cart.

Defined in

services/cart.ts:1430


findCustomShippingOption

findCustomShippingOption(cartCustomShippingOptions, optionId): undefined | CustomShippingOption

Finds the cart's custom shipping options based on the passed option id. throws if custom options is not empty and no shipping option corresponds to optionId

Parameters

NameTypeDescription
cartCustomShippingOptionsCustomShippingOption[]the cart's custom shipping options
optionIdstringid of the normal or custom shipping option to find in the cartCustomShippingOptions

Returns

undefined | CustomShippingOption

custom shipping option

Defined in

services/cart.ts:1626


list

list(selector, config?): Promise<Cart[]>

Parameters

NameTypeDescription
selectorFilterableCartPropsthe query object for find
configFindConfig<Cart>config object

Returns

Promise<Cart[]>

the result of the find operation

Defined in

services/cart.ts:254


refreshAdjustments_

Protected refreshAdjustments_(cart): Promise<void>

Parameters

NameType
cartCart

Returns

Promise<void>

Defined in

services/cart.ts:1946


refreshPaymentSession

refreshPaymentSession(cartId, providerId): Promise<Cart>

Refreshes a payment session on a cart

Parameters

NameTypeDescription
cartIdstringthe id of the cart to remove from
providerIdstringthe id of the provider whoose payment session should be removed.

Returns

Promise<Cart>

the resulting cart.

Defined in

services/cart.ts:1478


removeDiscount

removeDiscount(cartId, discountCode): Promise<Cart>

Removes a discount based on a discount code.

Parameters

NameTypeDescription
cartIdstringthe id of the cart to remove from
discountCodestringthe discount code to remove

Returns

Promise<Cart>

the resulting cart

Defined in

services/cart.ts:1104


removeLineItem

removeLineItem(cartId, lineItemId): Promise<Cart>

Removes a line item from the cart.

Parameters

NameTypeDescription
cartIdstringthe id of the cart that we will remove from
lineItemIdstringthe line item to remove.

Returns

Promise<Cart>

the result of the update operation

Defined in

services/cart.ts:432


retrieve

retrieve(cartId, options?, totalsConfig?): Promise<Cart>

Gets a cart by id.

Parameters

NameTypeDescription
cartIdstringthe id of the cart to get.
optionsFindConfig<Cart>the options to get a cart
totalsConfigTotalsConfigconfiguration for retrieval of totals

Returns

Promise<Cart>

the cart document.

Defined in

services/cart.ts:277


setMetadata

setMetadata(cartId, key, value): Promise<Cart>

Dedicated method to set metadata for a cart. To ensure that plugins does not overwrite each others metadata fields, setMetadata is provided.

Parameters

NameTypeDescription
cartIdstringthe cart to apply metadata to.
keystringkey for metadata field
valuestring | numbervalue for metadata field.

Returns

Promise<Cart>

resolves to the updated result.

Defined in

services/cart.ts:1877


setPaymentSession

setPaymentSession(cartId, providerId): Promise<Cart>

Sets a payment method for a cart.

Parameters

NameTypeDescription
cartIdstringthe id of the cart to add payment method to
providerIdstringthe id of the provider to be set to the cart

Returns

Promise<Cart>

result of update operation

Defined in

services/cart.ts:1249


setPaymentSessions

setPaymentSessions(cartOrCartId): Promise<void>

Creates, updates and sets payment sessions associated with the cart. The first time the method is called payment sessions will be created for each provider. Additional calls will ensure that payment sessions have correct amounts, currencies, etc. as well as make sure to filter payment sessions that are not available for the cart's region.

Parameters

NameTypeDescription
cartOrCartIdstring | Cartthe id of the cart to set payment session for

Returns

Promise<void>

the result of the update operation.

Defined in

services/cart.ts:1322


setRegion_

Protected setRegion_(cart, regionId, countryCode): Promise<void>

Set's the region of a cart.

Parameters

NameTypeDescription
cartCartthe cart to set region on
regionIdstringthe id of the region to set the region to
countryCodenull | stringthe country code to set the country to

Returns

Promise<void>

the result of the update operation

Defined in

services/cart.ts:1705


shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

NameType
errRecord<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

interfaces/transaction-base-service.ts:34


transformQueryForTotals_

Protected transformQueryForTotals_(config): FindConfig<Cart> & { totalsToSelect: TotalField[] }

Parameters

NameType
configFindConfig<Cart>

Returns

FindConfig<Cart> & { totalsToSelect: TotalField[] }

Defined in

services/cart.ts:157


update

update(cartId, data): Promise<Cart>

Parameters

NameType
cartIdstring
dataCartUpdateProps

Returns

Promise<Cart>

Defined in

services/cart.ts:716


updateBillingAddress_

Protected updateBillingAddress_(cart, addressOrId, addrRepo): Promise<void>

Updates the cart's billing address.

Parameters

NameTypeDescription
cartCartthe cart to update
addressOrIdstring | AddressPayload | Partial<Address>the value to set the billing address to
addrRepoAddressRepositorythe repository to use for address updates

Returns

Promise<void>

the result of the update operation

Defined in

services/cart.ts:919


updateCustomerId_

Protected updateCustomerId_(cart, customerId): Promise<void>

Sets the customer id of a cart

Parameters

NameTypeDescription
cartCartthe cart to add email to
customerIdstringthe customer to add to cart

Returns

Promise<void>

the result of the update operation

Defined in

services/cart.ts:868


updateLineItem

updateLineItem(cartId, lineItemId, lineItemUpdate): Promise<Cart>

Updates a cart's existing line item.

Parameters

NameTypeDescription
cartIdstringthe id of the cart to update
lineItemIdstringthe id of the line item to update.
lineItemUpdateLineItemUpdatethe line item to update. Must include an id field.

Returns

Promise<Cart>

the result of the update operation

Defined in

services/cart.ts:615


updatePaymentSession

updatePaymentSession(cartId, update): Promise<Cart>

Updates the currently selected payment session.

Parameters

NameTypeDescription
cartIdstringthe id of the cart to update the payment session for
updateobjectthe data to update the payment session with

Returns

Promise<Cart>

the resulting cart

Defined in

services/cart.ts:1148


updateShippingAddress_

Protected updateShippingAddress_(cart, addressOrId, addrRepo): Promise<void>

Updates the cart's shipping address.

Parameters

NameTypeDescription
cartCartthe cart to update
addressOrIdstring | AddressPayload | Partial<Address>the value to set the shipping address to
addrRepoAddressRepositorythe repository to use for address updates

Returns

Promise<void>

the result of the update operation

Defined in

services/cart.ts:959


updateUnitPrices_

Protected updateUnitPrices_(cart, regionId?, customer_id?): Promise<void>

Parameters

NameType
cartCart
regionId?string
customer_id?string

Returns

Promise<void>

Defined in

services/cart.ts:1645


validateLineItemShipping_

Protected validateLineItemShipping_(shippingMethods, lineItem): boolean

Checks if a given line item has a shipping method that can fulfill it. Returns true if all products in the cart can be fulfilled with the current shipping methods.

Parameters

NameTypeDescription
shippingMethodsShippingMethod[]the set of shipping methods to check from
lineItemLineItemthe line item

Returns

boolean

boolean representing wheter shipping method is validated

Defined in

services/cart.ts:498


withTransaction

withTransaction(transactionManager?): CartService

Parameters

NameType
transactionManager?EntityManager

Returns

CartService

Inherited from

TransactionBaseService.withTransaction

Defined in

interfaces/transaction-base-service.ts:16