Skip to main content

Class: LineItemService

Hierarchy

  • TransactionBaseService

    LineItemService

Constructors

constructor

new LineItemService(__namedParameters)

Parameters

NameType
__namedParametersInjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/line-item.ts:56

Properties

__configModule__

Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

medusa/src/interfaces/transaction-base-service.ts:14


__container__

Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

medusa/src/interfaces/transaction-base-service.ts:13


__moduleDeclaration__

Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15


cartRepository_

Protected Readonly cartRepository_: Repository<Cart> & { findOneWithRelations: (relations: FindOptionsRelations<Cart>, optionsWithoutRelations: Omit<FindManyOptions<Cart>, "relations">) => Promise<Cart> ; findWithRelations: (relations: FindOptionsRelations<Cart>, optionsWithoutRelations: Omit<FindManyOptions<Cart>, "relations">) => Promise<Cart[]> }

Defined in

medusa/src/services/line-item.ts:47


featureFlagRouter_

Protected Readonly featureFlagRouter_: FlagRouter

Defined in

medusa/src/services/line-item.ts:52


itemTaxLineRepo_

Protected Readonly itemTaxLineRepo_: Repository<LineItemTaxLine> & { deleteForCart: (cartId: string) => Promise<void> ; upsertLines: (lines: LineItemTaxLine[]) => Promise<LineItemTaxLine[]> }

Defined in

medusa/src/services/line-item.ts:46


lineItemAdjustmentService_

Protected Readonly lineItemAdjustmentService_: LineItemAdjustmentService

Defined in

medusa/src/services/line-item.ts:53


lineItemRepository_

Protected Readonly lineItemRepository_: Repository<LineItem> & { findByReturn: (returnId: string) => Promise<LineItem & { return_item: ReturnItem }[]> }

Defined in

medusa/src/services/line-item.ts:45


manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5


pricingService_

Protected Readonly pricingService_: PricingService

Defined in

medusa/src/services/line-item.ts:50


productService_

Protected Readonly productService_: ProductService

Defined in

medusa/src/services/line-item.ts:49


productVariantService_

Protected Readonly productVariantService_: ProductVariantService

Defined in

medusa/src/services/line-item.ts:48


regionService_

Protected Readonly regionService_: RegionService

Defined in

medusa/src/services/line-item.ts:51


taxProviderService_

Protected Readonly taxProviderService_: TaxProviderService

Defined in

medusa/src/services/line-item.ts:54


transactionManager_

Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6

Accessors

activeManager_

Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

Methods

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

medusa/src/interfaces/transaction-base-service.ts:56


cloneTo

cloneTo(ids, data?, options?): Promise<LineItem[]>

Parameters

NameType
idsstring | string[]
dataDeepPartial<LineItem>
optionsObject
options.setOriginalLineItemId?boolean

Returns

Promise<LineItem[]>

Defined in

medusa/src/services/line-item.ts:513


create

create<T, TResult>(data): Promise<TResult>

Create a line item

Type parameters

NameType
TLineItem | LineItem[]
TResultT extends LineItem[] ? LineItem[] : LineItem

Parameters

NameTypeDescription
dataTthe line item object to create

Returns

Promise<TResult>

the created line item

Defined in

medusa/src/services/line-item.ts:392


createReturnLines

createReturnLines(returnId, cartId): Promise<LineItem[]>

Creates return line items for a given cart based on the return items in a return.

Parameters

NameTypeDescription
returnIdstringthe id to generate return items from.
cartIdstringthe cart to assign the return line items to.

Returns

Promise<LineItem[]>

the created line items

Defined in

medusa/src/services/line-item.ts:130


createTaxLine

createTaxLine(args): LineItemTaxLine

Create a line item tax line.

Parameters

NameTypeDescription
argsDeepPartial<LineItemTaxLine>tax line partial passed to the repo create method

Returns

LineItemTaxLine

a new line item tax line

Defined in

medusa/src/services/line-item.ts:505


delete

delete(id): Promise<undefined | null | LineItem>

Deletes a line item.

Parameters

NameTypeDescription
idstringthe id of the line item to delete

Returns

Promise<undefined | null | LineItem>

the result of the delete operation

Defined in

medusa/src/services/line-item.ts:465


deleteWithTaxLines

deleteWithTaxLines(id): Promise<undefined | null | LineItem>

Deletes a line item with the tax lines.

Parameters

NameTypeDescription
idstringthe id of the line item to delete

Returns

Promise<undefined | null | LineItem>

the result of the delete operation

Defined in

medusa/src/services/line-item.ts:484


generate

generate<T, TResult>(variantIdOrData, regionIdOrContext, quantity?, context?): Promise<TResult>

Generate a single or multiple line item without persisting the data into the db

Type parameters

NameType
Tstring | GenerateInputData | GenerateInputData[]
TResultT extends string ? LineItem : T extends LineItem ? LineItem : LineItem[]

Parameters

NameType
variantIdOrDataT
regionIdOrContextT extends string ? string : GenerateLineItemContext
quantity?number
contextGenerateLineItemContext

Returns

Promise<TResult>

Defined in

medusa/src/services/line-item.ts:191


generateLineItem

Protected generateLineItem(variant, quantity, context): Promise<LineItem>

Parameters

NameType
variantObject
variant.idstring
variant.productObject
variant.product.discountableboolean
variant.product.is_giftcardboolean
variant.product.thumbnailnull | string
variant.product.titlestring
variant.product_idstring
variant.titlestring
quantitynumber
contextGenerateLineItemContext & { variantPricing: ProductVariantPricing }

Returns

Promise<LineItem>

Defined in

medusa/src/services/line-item.ts:316


list

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

Parameters

NameType
selectorSelector<LineItem>
configFindConfig<LineItem>

Returns

Promise<LineItem[]>

Defined in

medusa/src/services/line-item.ts:83


retrieve

retrieve(id, config?): Promise<LineItem>

Retrieves a line item by its id.

Parameters

NameTypeDescription
idstringthe id of the line item to retrieve
configObjectthe config to be used at query building

Returns

Promise<LineItem>

the line item

Defined in

medusa/src/services/line-item.ts:104


shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37


update

update(idOrSelector, data): Promise<LineItem[]>

Updates a line item

Parameters

NameTypeDescription
idOrSelectorstring | Selector<LineItem>the id or selector of the line item(s) to update
dataPartial<LineItem>the properties to update the line item(s)

Returns

Promise<LineItem[]>

the updated line item(s)

Defined in

medusa/src/services/line-item.ts:422


validateGenerateArguments

Protected validateGenerateArguments<T, TResult>(variantIdOrData, regionIdOrContext, quantity?): void

Type parameters

NameType
Tstring | GenerateInputData | GenerateInputData[]
TResultT extends string ? LineItem : T extends LineItem ? LineItem : LineItem[]

Parameters

NameType
variantIdOrDatastring | T
regionIdOrContextT extends string ? string : GenerateLineItemContext
quantity?number

Returns

void

Defined in

medusa/src/services/line-item.ts:584


withTransaction

withTransaction(transactionManager?): LineItemService

Parameters

NameType
transactionManager?EntityManager

Returns

LineItemService

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20

Was this page helpful?