Class: LineItemService

Hierarchy

• TransactionBaseServiceCopy to Clipboard

  ↳ LineItemServiceCopy to Clipboard

Constructors

constructor

• new LineItemService(__namedParametersCopy to Clipboard)

Parameters

Name	Type
__namedParametersCopy to Clipboard	InjectedDependenciesCopy to Clipboard

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/line-item.ts:59

Properties

__configModule__

• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __configModule__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Inherited from

TransactionBaseService.__configModule__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:10

---

__container__

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard __container__: anyCopy to Clipboard

Inherited from

TransactionBaseService.__container__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:9

---

__moduleDeclaration__

• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __moduleDeclaration__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:11

---

cartRepository_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard cartRepository_: typeof CartRepositoryCopy to Clipboard

Defined in

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

---

featureFlagRouter_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard featureFlagRouter_: FlagRouterCopy to Clipboard

Defined in

packages/medusa/src/services/line-item.ts:55

---

itemTaxLineRepo_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard itemTaxLineRepo_: typeof LineItemTaxLineRepositoryCopy to Clipboard

Defined in

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

---

lineItemAdjustmentService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard lineItemAdjustmentService_: LineItemAdjustmentServiceCopy to Clipboard

Defined in

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

---

lineItemRepository_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard lineItemRepository_: typeof LineItemRepositoryCopy to Clipboard

Defined in

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

---

manager_

• ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard

Overrides

TransactionBaseService.manager_

Defined in

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

---

pricingService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard pricingService_: PricingServiceCopy to Clipboard

Defined in

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

---

productService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard productService_: ProductServiceCopy to Clipboard

Defined in

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

---

productVariantService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard productVariantService_: ProductVariantServiceCopy to Clipboard

Defined in

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

---

regionService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard regionService_: RegionServiceCopy to Clipboard

Defined in

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

---

taxProviderService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard taxProviderService_: TaxProviderServiceCopy to Clipboard

Defined in

packages/medusa/src/services/line-item.ts:57

---

transactionManager_

• ProtectedCopy to Clipboard transactionManager_: undefinedCopy to Clipboard | EntityManagerCopy to Clipboard

Overrides

TransactionBaseService.transactionManager_

Defined in

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

Methods

atomicPhase_

▸ ProtectedCopy to Clipboard atomicPhase_<TResultCopy to Clipboard, TErrorCopy to Clipboard>(workCopy to Clipboard, isolationOrErrorHandler?Copy to Clipboard, maybeErrorHandlerOrDontFail?Copy to Clipboard): PromiseCopy to Clipboard<TResultCopy to Clipboard>

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
TResultCopy to Clipboard
TErrorCopy to Clipboard

Parameters

Name	Type	Description
workCopy to Clipboard	(transactionManagerCopy to Clipboard: EntityManagerCopy to Clipboard) => PromiseCopy to Clipboard<TResultCopy to Clipboard>	the transactional work to be done
isolationOrErrorHandler?Copy to Clipboard	IsolationLevelCopy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard>	the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?Copy to Clipboard	(errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard>	Potential error handler

Returns

PromiseCopy to Clipboard<TResultCopy to Clipboard>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:50

---

cloneTo

▸ cloneTo(idsCopy to Clipboard, data?Copy to Clipboard, options?Copy to Clipboard): PromiseCopy to Clipboard<LineItemCopy to Clipboard[]>

Parameters

Name	Type
idsCopy to Clipboard	stringCopy to Clipboard | stringCopy to Clipboard[]
dataCopy to Clipboard	ObjectCopy to Clipboard
data.adjustments?Copy to Clipboard	(undefinedCopy to Clipboard | { id?: string | undefined; item_id?: string | undefined; item?: { cart_id?: string | undefined; cart?: { readonly object?: "cart" | undefined; email?: string | undefined; billing_address_id?: string | undefined; ... 37 more ...; updated_at?: { ...; } | undefined; } | undefined; ... 38 more ...; updated_at?: { ...; }...)[]
data.allow_discounts?Copy to Clipboard	booleanCopy to Clipboard
data.cart?Copy to Clipboard	{ readonly object?: "cart" | undefined; email?: string | undefined; billing_address_id?: string | undefined; billing_address?: { customer_id?: string | null | undefined; customer?: { ...; } | ... 1 more ... | undefined; ... 15 more ...; updated_at?: { ...; } | undefined; } | undefined; ... 36 more ...; updated_at?: ...
data.cart_id?Copy to Clipboard	stringCopy to Clipboard
data.claim_order?Copy to Clipboard	{ payment_status?: ClaimPaymentStatus | undefined; fulfillment_status?: ClaimFulfillmentStatus | undefined; claim_items?: ({ images?: ({ ...; } | undefined)[] | undefined; ... 14 more ...; updated_at?: { ...; } | undefined; } | undefined)[] | undefined; ... 17 more ...; id?: string | undefined; }
data.claim_order_id?Copy to Clipboard	stringCopy to Clipboard
data.created_at?Copy to Clipboard	{ toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }
data.description?Copy to Clipboard	nullCopy to Clipboard | stringCopy to Clipboard
data.discount_total?Copy to Clipboard	nullCopy to Clipboard | numberCopy to Clipboard
data.fulfilled_quantity?Copy to Clipboard	nullCopy to Clipboard | numberCopy to Clipboard
data.gift_card_total?Copy to Clipboard	nullCopy to Clipboard | numberCopy to Clipboard
data.has_shipping?Copy to Clipboard	nullCopy to Clipboard | booleanCopy to Clipboard
data.id?Copy to Clipboard	stringCopy to Clipboard
data.includes_tax?Copy to Clipboard	booleanCopy to Clipboard
data.is_giftcard?Copy to Clipboard	booleanCopy to Clipboard
data.is_return?Copy to Clipboard	booleanCopy to Clipboard
data.metadata?Copy to Clipboard	{ [x: string]: unknown; }
data.order?Copy to Clipboard	{ readonly object?: "order" | undefined; status?: OrderStatus | undefined; fulfillment_status?: FulfillmentStatus | undefined; payment_status?: PaymentStatus | undefined; ... 49 more ...; updated_at?: { ...; } | undefined; }
data.order_edit?Copy to Clipboard	nullCopy to Clipboard | { order_id?: string | undefined; order?: { readonly object?: "order" | undefined; status?: OrderStatus | undefined; fulfillment_status?: FulfillmentStatus | undefined; ... 50 more ...; updated_at?: { ...; } | undefined; } | undefined; ... 27 more ...; updated_at?: { ...; } | undefined; }
data.order_edit_id?Copy to Clipboard	nullCopy to Clipboard | stringCopy to Clipboard
data.order_id?Copy to Clipboard	nullCopy to Clipboard | stringCopy to Clipboard
data.original_item_id?Copy to Clipboard	nullCopy to Clipboard | stringCopy to Clipboard
data.original_tax_total?Copy to Clipboard	nullCopy to Clipboard | numberCopy to Clipboard
data.original_total?Copy to Clipboard	nullCopy to Clipboard | numberCopy to Clipboard
data.quantity?Copy to Clipboard	numberCopy to Clipboard
data.refundable?Copy to Clipboard	nullCopy to Clipboard | numberCopy to Clipboard
data.returned_quantity?Copy to Clipboard	nullCopy to Clipboard | numberCopy to Clipboard
data.shipped_quantity?Copy to Clipboard	nullCopy to Clipboard | numberCopy to Clipboard
data.should_merge?Copy to Clipboard	booleanCopy to Clipboard
data.subtotal?Copy to Clipboard	nullCopy to Clipboard | numberCopy to Clipboard
data.swap?Copy to Clipboard	{ fulfillment_status?: SwapFulfillmentStatus | undefined; payment_status?: SwapPaymentStatus | undefined; order_id?: string | undefined; ... 20 more ...; updated_at?: { ...; } | undefined; }
data.swap_id?Copy to Clipboard	stringCopy to Clipboard
data.tax_lines?Copy to Clipboard	(undefinedCopy to Clipboard | { item_id?: string | undefined; item?: { cart_id?: string | undefined; cart?: { readonly object?: "cart" | undefined; email?: string | undefined; billing_address_id?: string | undefined; ... 37 more ...; updated_at?: { ...; } | undefined; } | undefined; ... 38 more ...; updated_at?: { ...; } | undefined; } | undefin...)[]
data.tax_total?Copy to Clipboard	nullCopy to Clipboard | numberCopy to Clipboard
data.thumbnail?Copy to Clipboard	nullCopy to Clipboard | stringCopy to Clipboard
data.title?Copy to Clipboard	stringCopy to Clipboard
data.total?Copy to Clipboard	nullCopy to Clipboard | numberCopy to Clipboard
data.unit_price?Copy to Clipboard	numberCopy to Clipboard
data.updated_at?Copy to Clipboard	{ toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }
data.variant?Copy to Clipboard	{ title?: string | undefined; product_id?: string | undefined; product?: { title?: string | undefined; subtitle?: string | null | undefined; description?: string | null | undefined; ... 30 more ...; updated_at?: { ...; } | undefined; } | undefined; ... 23 more ...; updated_at?: { ...; } | undefined; }
data.variant_id?Copy to Clipboard	nullCopy to Clipboard | stringCopy to Clipboard
optionsCopy to Clipboard	ObjectCopy to Clipboard
options.setOriginalLineItemId?Copy to Clipboard	booleanCopy to Clipboard

Returns

PromiseCopy to Clipboard<LineItemCopy to Clipboard[]>

Defined in

packages/medusa/src/services/line-item.ts:487

---

create

▸ create<TCopy to Clipboard, TResultCopy to Clipboard>(dataCopy to Clipboard): PromiseCopy to Clipboard<TResultCopy to Clipboard>

Create a line item

Type parameters

Name	Type
TCopy to Clipboard	LineItemCopy to Clipboard | LineItemCopy to Clipboard[]
TResultCopy to Clipboard	TCopy to Clipboard extends LineItemCopy to Clipboard[] ? LineItemCopy to Clipboard[] : LineItemCopy to Clipboard

Parameters

Name	Type	Description
dataCopy to Clipboard	TCopy to Clipboard	the line item object to create

Returns

PromiseCopy to Clipboard<TResultCopy to Clipboard>

the created line item

Defined in

packages/medusa/src/services/line-item.ts:368

---

createReturnLines

▸ createReturnLines(returnIdCopy to Clipboard, cartIdCopy to Clipboard): PromiseCopy to Clipboard<LineItemCopy to Clipboard[]>

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

Parameters

Name	Type	Description
returnIdCopy to Clipboard	stringCopy to Clipboard	the id to generate return items from.
cartIdCopy to Clipboard	stringCopy to Clipboard	the cart to assign the return line items to.

Returns

PromiseCopy to Clipboard<LineItemCopy to Clipboard[]>

the created line items

Defined in

packages/medusa/src/services/line-item.ts:135

---

createTaxLine

▸ createTaxLine(argsCopy to Clipboard): LineItemTaxLineCopy to Clipboard

Create a line item tax line.

Parameters

Name	Type	Description
argsCopy to Clipboard	ObjectCopy to Clipboard	tax line partial passed to the repo create method
args.code?Copy to Clipboard	nullCopy to Clipboard | stringCopy to Clipboard	-
args.created_at?Copy to Clipboard	{ toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }	-
args.id?Copy to Clipboard	stringCopy to Clipboard	-
args.item?Copy to Clipboard	{ cart_id?: string | undefined; cart?: { readonly object?: "cart" | undefined; email?: string | undefined; billing_address_id?: string | undefined; billing_address?: { customer_id?: string | ... 1 more ... | undefined; ... 16 more ...; updated_at?: { ...; } | undefined; } | undefined; ... 36 more ...; updated_at?: {...	-
args.item_id?Copy to Clipboard	stringCopy to Clipboard	-
args.metadata?Copy to Clipboard	{ [x: string]: unknown; }	-
args.name?Copy to Clipboard	stringCopy to Clipboard	-
args.rate?Copy to Clipboard	numberCopy to Clipboard	-
args.updated_at?Copy to Clipboard	{ toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }	-

Returns

LineItemTaxLineCopy to Clipboard

a new line item tax line

Defined in

packages/medusa/src/services/line-item.ts:479

---

delete

▸ delete(idCopy to Clipboard): PromiseCopy to Clipboard<undefinedCopy to Clipboard | LineItemCopy to Clipboard>

Deletes a line item.

Parameters

Name	Type	Description
idCopy to Clipboard	stringCopy to Clipboard	the id of the line item to delete

Returns

PromiseCopy to Clipboard<undefinedCopy to Clipboard | LineItemCopy to Clipboard>

the result of the delete operation

Defined in

packages/medusa/src/services/line-item.ts:439

---

deleteWithTaxLines

▸ deleteWithTaxLines(idCopy to Clipboard): PromiseCopy to Clipboard<undefinedCopy to Clipboard | LineItemCopy to Clipboard>

Deletes a line item with the tax lines.

Parameters

Name	Type	Description
idCopy to Clipboard	stringCopy to Clipboard	the id of the line item to delete

Returns

PromiseCopy to Clipboard<undefinedCopy to Clipboard | LineItemCopy to Clipboard>

the result of the delete operation

Defined in

packages/medusa/src/services/line-item.ts:458

---

generate

▸ generate<TCopy to Clipboard, TResultCopy to Clipboard>(variantIdOrDataCopy to Clipboard, regionIdOrContextCopy to Clipboard, quantity?Copy to Clipboard, context?Copy to Clipboard): PromiseCopy to Clipboard<TResultCopy to Clipboard>

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

Type parameters

Name	Type
TCopy to Clipboard	stringCopy to Clipboard | GenerateInputDataCopy to Clipboard | GenerateInputDataCopy to Clipboard[]
TResultCopy to Clipboard	TCopy to Clipboard extends stringCopy to Clipboard ? LineItemCopy to Clipboard : TCopy to Clipboard extends LineItemCopy to Clipboard ? LineItemCopy to Clipboard : LineItemCopy to Clipboard[]

Parameters

Name	Type
variantIdOrDataCopy to Clipboard	TCopy to Clipboard
regionIdOrContextCopy to Clipboard	TCopy to Clipboard extends stringCopy to Clipboard ? stringCopy to Clipboard : GenerateLineItemContextCopy to Clipboard
quantity?Copy to Clipboard	numberCopy to Clipboard
contextCopy to Clipboard	GenerateLineItemContextCopy to Clipboard

Returns

PromiseCopy to Clipboard<TResultCopy to Clipboard>

Defined in

packages/medusa/src/services/line-item.ts:196

---

generateLineItem

▸ ProtectedCopy to Clipboard generateLineItem(variantCopy to Clipboard, quantityCopy to Clipboard, contextCopy to Clipboard): PromiseCopy to Clipboard<LineItemCopy to Clipboard>

Parameters

Name	Type
variantCopy to Clipboard	ObjectCopy to Clipboard
variant.idCopy to Clipboard	stringCopy to Clipboard
variant.productCopy to Clipboard	ObjectCopy to Clipboard
variant.product.discountableCopy to Clipboard	booleanCopy to Clipboard
variant.product.is_giftcardCopy to Clipboard	booleanCopy to Clipboard
variant.product.thumbnailCopy to Clipboard	nullCopy to Clipboard | stringCopy to Clipboard
variant.product.titleCopy to Clipboard	stringCopy to Clipboard
variant.product_idCopy to Clipboard	stringCopy to Clipboard
variant.titleCopy to Clipboard	stringCopy to Clipboard
quantityCopy to Clipboard	numberCopy to Clipboard
contextCopy to Clipboard	GenerateLineItemContextCopy to Clipboard & { variantPricingCopy to Clipboard: ProductVariantPricingCopy to Clipboard }

Returns

PromiseCopy to Clipboard<LineItemCopy to Clipboard>

Defined in

packages/medusa/src/services/line-item.ts:299

---

list

▸ list(selectorCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<LineItemCopy to Clipboard[]>

Parameters

Name	Type
selectorCopy to Clipboard	SelectorCopy to Clipboard<LineItemCopy to Clipboard>
configCopy to Clipboard	FindConfigCopy to Clipboard<LineItemCopy to Clipboard>

Returns

PromiseCopy to Clipboard<LineItemCopy to Clipboard[]>

Defined in

packages/medusa/src/services/line-item.ts:88

---

retrieve

▸ retrieve(idCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<LineItemCopy to Clipboard>

Retrieves a line item by its id.

Parameters

Name	Type	Description
idCopy to Clipboard	stringCopy to Clipboard	the id of the line item to retrieve
configCopy to Clipboard	ObjectCopy to Clipboard	the config to be used at query building

Returns

PromiseCopy to Clipboard<LineItemCopy to Clipboard>

the line item

Defined in

packages/medusa/src/services/line-item.ts:108

---

shouldRetryTransaction_

▸ ProtectedCopy to Clipboard shouldRetryTransaction_(errCopy to Clipboard): booleanCopy to Clipboard

Parameters

Name	Type
errCopy to Clipboard	RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | { codeCopy to Clipboard: stringCopy to Clipboard }

Returns

booleanCopy to Clipboard

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:31

---

update

▸ update(idOrSelectorCopy to Clipboard, dataCopy to Clipboard): PromiseCopy to Clipboard<LineItemCopy to Clipboard[]>

Updates a line item

Parameters

Name	Type	Description
idOrSelectorCopy to Clipboard	stringCopy to Clipboard | SelectorCopy to Clipboard<LineItemCopy to Clipboard>	the id or selector of the line item(s) to update
dataCopy to Clipboard	PartialCopy to Clipboard<LineItemCopy to Clipboard>	the properties to update the line item(s)

Returns

PromiseCopy to Clipboard<LineItemCopy to Clipboard[]>

the updated line item(s)

Defined in

packages/medusa/src/services/line-item.ts:396

---

validateGenerateArguments

▸ ProtectedCopy to Clipboard validateGenerateArguments<TCopy to Clipboard, TResultCopy to Clipboard>(variantIdOrDataCopy to Clipboard, regionIdOrContextCopy to Clipboard, quantity?Copy to Clipboard): voidCopy to Clipboard

Type parameters

Name	Type
TCopy to Clipboard	stringCopy to Clipboard | GenerateInputDataCopy to Clipboard | GenerateInputDataCopy to Clipboard[]
TResultCopy to Clipboard	TCopy to Clipboard extends stringCopy to Clipboard ? LineItemCopy to Clipboard : TCopy to Clipboard extends LineItemCopy to Clipboard ? LineItemCopy to Clipboard : LineItemCopy to Clipboard[]

Parameters

Name	Type
variantIdOrDataCopy to Clipboard	stringCopy to Clipboard | TCopy to Clipboard
regionIdOrContextCopy to Clipboard	TCopy to Clipboard extends stringCopy to Clipboard ? stringCopy to Clipboard : GenerateLineItemContextCopy to Clipboard
quantity?Copy to Clipboard	numberCopy to Clipboard

Returns

voidCopy to Clipboard

Defined in

packages/medusa/src/services/line-item.ts:558

---

withTransaction

▸ withTransaction(transactionManager?Copy to Clipboard): LineItemServiceCopy to Clipboard

Parameters

Name	Type
transactionManager?Copy to Clipboard	EntityManagerCopy to Clipboard

Returns

LineItemServiceCopy to Clipboard

Inherited from

TransactionBaseService.withTransaction

Defined in

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