ICartModuleService

Methods

retrieve

Parameters

cartIdstringRequired

configFindConfig<CartDTO>

sharedContextContext

Returns

PromisePromise<CartDTO>Required

list

Parameters

filtersFilterableCartProps

configFindConfig<CartDTO>

sharedContextContext

Returns

PromisePromise<CartDTO[]>Required

listAndCount

Parameters

filtersFilterableCartProps

configFindConfig<CartDTO>

sharedContextContext

Returns

PromisePromise<[CartDTO[], number]>Required

create

**create**(data, sharedContext?): Promise<[CartDTO](/references/types/CartTypes/interfaces/types.CartTypes.CartDTO)[]>

Parameters

dataCreateCartDTO[]Required

sharedContextContext

Returns

PromisePromise<CartDTO[]>Required

**create**(data, sharedContext?): Promise<[CartDTO](/references/types/CartTypes/interfaces/types.CartTypes.CartDTO)>

Parameters

dataCreateCartDTORequired

sharedContextContext

Returns

PromisePromise<CartDTO>Required

update

**update**(data, sharedContext?): Promise<[CartDTO](/references/types/CartTypes/interfaces/types.CartTypes.CartDTO)[]>

Parameters

dataUpdateCartDTO[]Required

sharedContextContext

Returns

PromisePromise<CartDTO[]>Required

**update**(data, sharedContext?): Promise<[CartDTO](/references/types/CartTypes/interfaces/types.CartTypes.CartDTO)>

Parameters

dataUpdateCartDTORequired

sharedContextContext

Returns

PromisePromise<CartDTO>Required

delete

**delete**(cartIds, sharedContext?): Promise<void>

Parameters

cartIdsstring[]Required

sharedContextContext

Returns

PromisePromise<void>Required

**delete**(cartId, sharedContext?): Promise<void>

Parameters

cartIdstringRequired

sharedContextContext

Returns

PromisePromise<void>Required

listAddresses

Parameters

filtersFilterableAddressProps

configFindConfig<CartAddressDTO>

sharedContextContext

Returns

PromisePromise<CartAddressDTO[]>Required

createAddresses

**createAddresses**(data, sharedContext?): Promise<[CartAddressDTO](/references/types/CartTypes/interfaces/types.CartTypes.CartAddressDTO)[]>

Parameters

dataCreateAddressDTO[]Required

sharedContextContext

Returns

PromisePromise<CartAddressDTO[]>Required

**createAddresses**(data, sharedContext?): Promise<[CartAddressDTO](/references/types/CartTypes/interfaces/types.CartTypes.CartAddressDTO)>

Parameters

dataCreateAddressDTORequired

sharedContextContext

Returns

PromisePromise<CartAddressDTO>Required

updateAddresses

**updateAddresses**(data, sharedContext?): Promise<[CartAddressDTO](/references/types/CartTypes/interfaces/types.CartTypes.CartAddressDTO)[]>

Parameters

dataUpdateAddressDTO[]Required

sharedContextContext

Returns

PromisePromise<CartAddressDTO[]>Required

**updateAddresses**(data, sharedContext?): Promise<[CartAddressDTO](/references/types/CartTypes/interfaces/types.CartTypes.CartAddressDTO)>

Parameters

dataUpdateAddressDTORequired

sharedContextContext

Returns

PromisePromise<CartAddressDTO>Required

deleteAddresses

**deleteAddresses**(ids, sharedContext?): Promise<void>

Parameters

idsstring[]Required

sharedContextContext

Returns

PromisePromise<void>Required

**deleteAddresses**(ids, sharedContext?): Promise<void>

Parameters

idsstringRequired

sharedContextContext

Returns

PromisePromise<void>Required

retrieveLineItem

Parameters

itemIdstringRequired

configFindConfig<CartLineItemDTO>

sharedContextContext

Returns

PromisePromise<CartLineItemDTO>Required

listLineItems

Parameters

filtersFilterableLineItemPropsRequired

configFindConfig<CartLineItemDTO>

sharedContextContext

Returns

PromisePromise<CartLineItemDTO[]>Required

addLineItems

**addLineItems**(data): Promise<[CartLineItemDTO](/references/types/CartTypes/interfaces/types.CartTypes.CartLineItemDTO)[]>

Parameters

dataCreateLineItemForCartDTORequired

Returns

PromisePromise<CartLineItemDTO[]>Required

**addLineItems**(data): Promise<[CartLineItemDTO](/references/types/CartTypes/interfaces/types.CartTypes.CartLineItemDTO)[]>

Parameters

dataCreateLineItemForCartDTO[]Required

Returns

PromisePromise<CartLineItemDTO[]>Required

**addLineItems**(cartId, items, sharedContext?): Promise<[CartLineItemDTO](/references/types/CartTypes/interfaces/types.CartTypes.CartLineItemDTO)[]>

Parameters

cartIdstringRequired

itemsCreateLineItemDTO[]Required

sharedContextContext

Returns

PromisePromise<CartLineItemDTO[]>Required

updateLineItems

**updateLineItems**(data): Promise<[CartLineItemDTO](/references/types/CartTypes/interfaces/types.CartTypes.CartLineItemDTO)[]>

Parameters

dataUpdateLineItemWithSelectorDTO[]Required

Returns

PromisePromise<CartLineItemDTO[]>Required

**updateLineItems**(selector, data, sharedContext?): Promise<[CartLineItemDTO](/references/types/CartTypes/interfaces/types.CartTypes.CartLineItemDTO)[]>

Parameters

selectorPartial<CartLineItemDTO>Required

dataPartial<UpdateLineItemDTO>Required

sharedContextContext

Returns

PromisePromise<CartLineItemDTO[]>Required

**updateLineItems**(lineId, data, sharedContext?): Promise<[CartLineItemDTO](/references/types/CartTypes/interfaces/types.CartTypes.CartLineItemDTO)>

Parameters

lineIdstringRequired

dataPartial<UpdateLineItemDTO>Required

sharedContextContext

Returns

PromisePromise<CartLineItemDTO>Required

removeLineItems

**removeLineItems**(itemIds, sharedContext?): Promise<void>

Parameters

itemIdsstring[]Required

sharedContextContext

Returns

PromisePromise<void>Required

**removeLineItems**(itemIds, sharedContext?): Promise<void>

Parameters

itemIdsstringRequired

sharedContextContext

Returns

PromisePromise<void>Required

**removeLineItems**(selector, sharedContext?): Promise<void>

Parameters

selectorPartial<CartLineItemDTO>Required

sharedContextContext

Returns

PromisePromise<void>Required

listShippingMethods

Parameters

filtersFilterableShippingMethodPropsRequired

configFindConfig<CartShippingMethodDTO>Required

sharedContextContext

Returns

PromisePromise<CartShippingMethodDTO[]>Required

addShippingMethods

**addShippingMethods**(data): Promise<[CartShippingMethodDTO](/references/types/CartTypes/interfaces/types.CartTypes.CartShippingMethodDTO)>

Parameters

dataCreateShippingMethodDTORequired

Returns

PromisePromise<CartShippingMethodDTO>Required

**addShippingMethods**(data): Promise<[CartShippingMethodDTO](/references/types/CartTypes/interfaces/types.CartTypes.CartShippingMethodDTO)[]>

Parameters

dataCreateShippingMethodDTO[]Required

Returns

PromisePromise<CartShippingMethodDTO[]>Required

**addShippingMethods**(cartId, methods, sharedContext?): Promise<[CartShippingMethodDTO](/references/types/CartTypes/interfaces/types.CartTypes.CartShippingMethodDTO)[]>

Parameters

cartIdstringRequired

methodsCreateShippingMethodForSingleCartDTO[]Required

sharedContextContext

Returns

PromisePromise<CartShippingMethodDTO[]>Required

removeShippingMethods

**removeShippingMethods**(methodIds, sharedContext?): Promise<void>

Parameters

methodIdsstring[]Required

sharedContextContext

Returns

PromisePromise<void>Required

**removeShippingMethods**(methodIds, sharedContext?): Promise<void>

Parameters

methodIdsstringRequired

sharedContextContext

Returns

PromisePromise<void>Required

**removeShippingMethods**(selector, sharedContext?): Promise<void>

Parameters

selectorPartial<CartShippingMethodDTO>Required

sharedContextContext

Returns

PromisePromise<void>Required

listLineItemAdjustments

Parameters

filtersFilterableLineItemAdjustmentPropsRequired

configFindConfig<LineItemAdjustmentDTO>

sharedContextContext

Returns

PromisePromise<LineItemAdjustmentDTO[]>Required

addLineItemAdjustments

**addLineItemAdjustments**(data): Promise<[LineItemAdjustmentDTO](/references/types/CartTypes/interfaces/types.CartTypes.LineItemAdjustmentDTO)[]>

Parameters

dataCreateAdjustmentDTO[]Required

Returns

PromisePromise<LineItemAdjustmentDTO[]>Required

**addLineItemAdjustments**(data): Promise<[LineItemAdjustmentDTO](/references/types/CartTypes/interfaces/types.CartTypes.LineItemAdjustmentDTO)[]>

Parameters

dataCreateAdjustmentDTORequired

Returns

PromisePromise<LineItemAdjustmentDTO[]>Required

**addLineItemAdjustments**(cartId, data): Promise<[LineItemAdjustmentDTO](/references/types/CartTypes/interfaces/types.CartTypes.LineItemAdjustmentDTO)[]>

Parameters

cartIdstringRequired

dataCreateAdjustmentDTO[]Required

Returns

PromisePromise<LineItemAdjustmentDTO[]>Required

setLineItemAdjustments

Parameters

cartIdstringRequired

dataUpsertLineItemAdjustmentDTO[]Required

sharedContextContext

Returns

PromisePromise<LineItemAdjustmentDTO[]>Required

removeLineItemAdjustments

**removeLineItemAdjustments**(adjustmentIds, sharedContext?): Promise<void>

Parameters

adjustmentIdsstring[]Required

sharedContextContext

Returns

PromisePromise<void>Required

**removeLineItemAdjustments**(adjustmentIds, sharedContext?): Promise<void>

Parameters

adjustmentIdsstringRequired

sharedContextContext

Returns

PromisePromise<void>Required

**removeLineItemAdjustments**(selector, sharedContext?): Promise<void>

Parameters

selectorPartial<LineItemAdjustmentDTO>Required

sharedContextContext

Returns

PromisePromise<void>Required

listShippingMethodAdjustments

Parameters

filtersFilterableShippingMethodAdjustmentPropsRequired

configFindConfig<ShippingMethodAdjustmentDTO>

sharedContextContext

Returns

PromisePromise<ShippingMethodAdjustmentDTO[]>Required

addShippingMethodAdjustments

**addShippingMethodAdjustments**(data): Promise<[ShippingMethodAdjustmentDTO](/references/types/CartTypes/interfaces/types.CartTypes.ShippingMethodAdjustmentDTO)[]>

Parameters

dataCreateShippingMethodAdjustmentDTO[]Required

Returns

PromisePromise<ShippingMethodAdjustmentDTO[]>Required

**addShippingMethodAdjustments**(data): Promise<[ShippingMethodAdjustmentDTO](/references/types/CartTypes/interfaces/types.CartTypes.ShippingMethodAdjustmentDTO)>

Parameters

dataCreateShippingMethodAdjustmentDTORequired

Returns

PromisePromise<ShippingMethodAdjustmentDTO>Required

**addShippingMethodAdjustments**(cartId, data, sharedContext?): Promise<[ShippingMethodAdjustmentDTO](/references/types/CartTypes/interfaces/types.CartTypes.ShippingMethodAdjustmentDTO)[]>

Parameters

cartIdstringRequired

dataCreateShippingMethodAdjustmentDTO[]Required

sharedContextContext

Returns

PromisePromise<ShippingMethodAdjustmentDTO[]>Required

setShippingMethodAdjustments

Parameters

cartIdstringRequired

data(CreateShippingMethodAdjustmentDTO | UpdateShippingMethodAdjustmentDTO)[]Required

sharedContextContext

Returns

PromisePromise<ShippingMethodAdjustmentDTO[]>Required

removeShippingMethodAdjustments

**removeShippingMethodAdjustments**(adjustmentIds, sharedContext?): Promise<void>

Parameters

adjustmentIdsstring[]Required

sharedContextContext

Returns

PromisePromise<void>Required

**removeShippingMethodAdjustments**(adjustmentId, sharedContext?): Promise<void>

Parameters

adjustmentIdstringRequired

sharedContextContext

Returns

PromisePromise<void>Required

**removeShippingMethodAdjustments**(selector, sharedContext?): Promise<void>

Parameters

selectorPartial<ShippingMethodAdjustmentDTO>Required

sharedContextContext

Returns

PromisePromise<void>Required

listLineItemTaxLines

Parameters

filtersFilterableLineItemTaxLinePropsRequired

configFindConfig<LineItemTaxLineDTO>

sharedContextContext

Returns

PromisePromise<LineItemTaxLineDTO[]>Required

addLineItemTaxLines

**addLineItemTaxLines**(taxLines): Promise<[LineItemTaxLineDTO](/references/types/CartTypes/interfaces/types.CartTypes.LineItemTaxLineDTO)[]>

Parameters

taxLinesCreateLineItemTaxLineDTO[]Required

Returns

PromisePromise<LineItemTaxLineDTO[]>Required

**addLineItemTaxLines**(taxLine): Promise<[LineItemTaxLineDTO](/references/types/CartTypes/interfaces/types.CartTypes.LineItemTaxLineDTO)>

Parameters

taxLineCreateLineItemTaxLineDTORequired

Returns

PromisePromise<LineItemTaxLineDTO>Required

**addLineItemTaxLines**(cartId, taxLines, sharedContext?): Promise<[LineItemTaxLineDTO](/references/types/CartTypes/interfaces/types.CartTypes.LineItemTaxLineDTO)[]>

Parameters

cartIdstringRequired

taxLinesCreateLineItemTaxLineDTO | CreateLineItemTaxLineDTO[]Required

sharedContextContext

Returns

PromisePromise<LineItemTaxLineDTO[]>Required

setLineItemTaxLines

Parameters

cartIdstringRequired

taxLines(CreateLineItemTaxLineDTO | UpdateLineItemTaxLineDTO)[]Required

sharedContextContext

Returns

PromisePromise<LineItemTaxLineDTO[]>Required

removeLineItemTaxLines

**removeLineItemTaxLines**(taxLineIds, sharedContext?): Promise<void>

Parameters

taxLineIdsstring[]Required

sharedContextContext

Returns

PromisePromise<void>Required

**removeLineItemTaxLines**(taxLineIds, sharedContext?): Promise<void>

Parameters

taxLineIdsstringRequired

sharedContextContext

Returns

PromisePromise<void>Required

**removeLineItemTaxLines**(selector, sharedContext?): Promise<void>

Parameters

selectorFilterableLineItemTaxLinePropsRequired

sharedContextContext

Returns

PromisePromise<void>Required

listShippingMethodTaxLines

Parameters

filtersFilterableShippingMethodTaxLinePropsRequired

configFindConfig<ShippingMethodTaxLineDTO>

sharedContextContext

Returns

PromisePromise<ShippingMethodTaxLineDTO[]>Required

addShippingMethodTaxLines

**addShippingMethodTaxLines**(taxLines): Promise<[ShippingMethodTaxLineDTO](/references/types/CartTypes/interfaces/types.CartTypes.ShippingMethodTaxLineDTO)[]>

Parameters

taxLinesCreateShippingMethodTaxLineDTO[]Required

Returns

PromisePromise<ShippingMethodTaxLineDTO[]>Required

**addShippingMethodTaxLines**(taxLine): Promise<[ShippingMethodTaxLineDTO](/references/types/CartTypes/interfaces/types.CartTypes.ShippingMethodTaxLineDTO)>

Parameters

taxLineCreateShippingMethodTaxLineDTORequired

Returns

PromisePromise<ShippingMethodTaxLineDTO>Required

**addShippingMethodTaxLines**(cartId, taxLines, sharedContext?): Promise<[ShippingMethodTaxLineDTO](/references/types/CartTypes/interfaces/types.CartTypes.ShippingMethodTaxLineDTO)[]>

Parameters

cartIdstringRequired

taxLinesCreateShippingMethodTaxLineDTO | CreateShippingMethodTaxLineDTO[]Required

sharedContextContext

Returns

PromisePromise<ShippingMethodTaxLineDTO[]>Required

setShippingMethodTaxLines

Parameters

cartIdstringRequired

taxLines(CreateShippingMethodTaxLineDTO | UpdateShippingMethodTaxLineDTO)[]Required

sharedContextContext

Returns

PromisePromise<ShippingMethodTaxLineDTO[]>Required

removeShippingMethodTaxLines

**removeShippingMethodTaxLines**(taxLineIds, sharedContext?): Promise<void>

Parameters

taxLineIdsstring[]Required

sharedContextContext

Returns

PromisePromise<void>Required

**removeShippingMethodTaxLines**(taxLineIds, sharedContext?): Promise<void>

Parameters

taxLineIdsstringRequired

sharedContextContext

Returns

PromisePromise<void>Required

**removeShippingMethodTaxLines**(selector, sharedContext?): Promise<void>

Parameters

selectorFilterableShippingMethodTaxLinePropsRequired

sharedContextContext

Returns

PromisePromise<void>Required