6.7 KiB
Class: LineItemService
Provides layer to manipulate line items.
Hierarchy
-
"medusa-interfaces"↳
LineItemService
Constructors
constructor
• new LineItemService(__namedParameters)
Parameters
| Name | Type |
|---|---|
__namedParameters |
InjectedDependencies |
Overrides
BaseService.constructor
Defined in
packages/medusa/src/services/line-item.ts:45
Properties
cartRepository_
• Protected Readonly cartRepository_: typeof CartRepository
Defined in
packages/medusa/src/services/line-item.ts:39
itemTaxLineRepo_
• Protected Readonly itemTaxLineRepo_: typeof LineItemTaxLineRepository
Defined in
packages/medusa/src/services/line-item.ts:38
lineItemAdjustmentService_
• Protected Readonly lineItemAdjustmentService_: LineItemAdjustmentService
Defined in
packages/medusa/src/services/line-item.ts:43
lineItemRepository_
• Protected Readonly lineItemRepository_: typeof LineItemRepository
Defined in
packages/medusa/src/services/line-item.ts:37
manager_
• Protected Readonly manager_: EntityManager
Defined in
packages/medusa/src/services/line-item.ts:36
productService_
• Protected Readonly productService_: ProductService
Defined in
packages/medusa/src/services/line-item.ts:41
productVariantService_
• Protected Readonly productVariantService_: ProductVariantService
Defined in
packages/medusa/src/services/line-item.ts:40
regionService_
• Protected Readonly regionService_: RegionService
Defined in
packages/medusa/src/services/line-item.ts:42
Methods
create
▸ create(data): Promise<LineItem>
Create a line item
Parameters
| Name | Type | Description |
|---|---|---|
data |
Partial<LineItem> |
the line item object to create |
Returns
Promise<LineItem>
the created line item
Defined in
packages/medusa/src/services/line-item.ts:267
createReturnLines
▸ createReturnLines(returnId, cartId): Promise<LineItem[]>
Creates return line items for a given cart based on the return items in a return.
Parameters
| Name | Type | Description |
|---|---|---|
returnId |
string |
the id to generate return items from. |
cartId |
string |
the cart to assign the return line items to. |
Returns
Promise<LineItem[]>
the created line items
Defined in
packages/medusa/src/services/line-item.ts:139
delete
▸ delete(id): Promise<undefined | LineItem>
Deletes a line item.
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
the id of the line item to delete |
Returns
Promise<undefined | LineItem>
the result of the delete operation
Defined in
packages/medusa/src/services/line-item.ts:315
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
packages/medusa/src/services/line-item.ts:192
list
▸ list(selector, config?): Promise<LineItem[]>
Parameters
| Name | Type |
|---|---|
selector |
any |
config |
FindConfig<LineItem> |
Returns
Promise<LineItem[]>
Defined in
packages/medusa/src/services/line-item.ts:91
retrieve
▸ retrieve(id, config?): Promise<LineItem>
Retrieves a line item by its id.
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
the id of the line item to retrieve |
config |
Object |
the config to be used at query building |
Returns
Promise<LineItem>
the line item
Defined in
packages/medusa/src/services/line-item.ts:111
update
▸ update(id, data): Promise<LineItem>
Updates a line item
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
the id of the line item to update |
data |
Partial<LineItem> |
the properties to update on line item |
Returns
Promise<LineItem>
the update line item
Defined in
packages/medusa/src/services/line-item.ts:286
withTransaction
▸ withTransaction(transactionManager): LineItemService
Parameters
| Name | Type |
|---|---|
transactionManager |
EntityManager |