medusa-store/docs/content/references/services/classes/LineItemService.md

Class: LineItemService

Hierarchy

• "medusa-interfaces"

  ↳ LineItemService

Constructors

constructor

• new LineItemService(__namedParameters)

Parameters

Name	Type
__namedParameters	InjectedDependencies

Overrides

BaseService.constructor

Defined in

services/line-item.ts:44

Properties

cartRepository_

• Protected Readonly cartRepository_: typeof CartRepository

Defined in

services/line-item.ts:38

---

itemTaxLineRepo_

• Protected Readonly itemTaxLineRepo_: typeof LineItemTaxLineRepository

Defined in

services/line-item.ts:37

---

lineItemAdjustmentService_

• Protected Readonly lineItemAdjustmentService_: LineItemAdjustmentService

Defined in

services/line-item.ts:42

---

lineItemRepository_

• Protected Readonly lineItemRepository_: typeof LineItemRepository

Defined in

services/line-item.ts:36

---

manager_

• Protected Readonly manager_: EntityManager

Defined in

services/line-item.ts:35

---

productService_

• Protected Readonly productService_: ProductService

Defined in

services/line-item.ts:40

---

productVariantService_

• Protected Readonly productVariantService_: ProductVariantService

Defined in

services/line-item.ts:39

---

regionService_

• Protected Readonly regionService_: RegionService

Defined in

services/line-item.ts:41

Methods

create

▸ create(data): Promise<LineItem>

Parameters

Name	Type	Description
data	Partial<LineItem>

Returns

Promise<LineItem>

Defined in

services/line-item.ts:270

---

createReturnLines

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

Parameters

Name	Type	Description
returnId	string
cartId	string

Returns

Promise<LineItem[]>

Defined in

services/line-item.ts:142

---

delete

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

Parameters

Name	Type	Description
id	string

Returns

Promise<undefined | LineItem>

Defined in

services/line-item.ts:318

---

generate

▸ generate(variantId, regionId, quantity, context?): Promise<LineItem>

Parameters

Name	Type
variantId	string
regionId	string
quantity	number
context	Object
context.cart?	Cart
context.customer_id?	string
context.metadata?	Record<string, unknown>
context.unit_price?	number

Returns

Promise<LineItem>

Defined in

services/line-item.ts:195

---

list

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

Parameters

Name	Type	Default value
selector	any	undefined
config	Object	undefined
config.order	Object	undefined
config.order.created_at	string	"DESC"
config.skip	number	0
config.take	number	50

Returns

Promise<LineItem[]>

Defined in

services/line-item.ts:90

---

retrieve

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

Parameters

Name	Type	Description
id	string
config	Object

Returns

Promise<LineItem>

Defined in

services/line-item.ts:111

---

update

▸ update(id, data): Promise<LineItem>

Parameters

Name	Type	Description
id	string
data	Partial<LineItem>

Returns

Promise<LineItem>

Defined in

services/line-item.ts:289

---

withTransaction

▸ withTransaction(transactionManager): LineItemService

Parameters

Name	Type
transactionManager	EntityManager

Returns

LineItemService

Defined in

services/line-item.ts:68