302 lines
6.7 KiB
Markdown
302 lines
6.7 KiB
Markdown
# 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](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/line-item.ts#L45)
|
|
|
|
## Properties
|
|
|
|
### cartRepository\_
|
|
|
|
• `Protected` `Readonly` **cartRepository\_**: typeof `CartRepository`
|
|
|
|
#### Defined in
|
|
|
|
[packages/medusa/src/services/line-item.ts:39](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/line-item.ts#L39)
|
|
|
|
___
|
|
|
|
### itemTaxLineRepo\_
|
|
|
|
• `Protected` `Readonly` **itemTaxLineRepo\_**: typeof `LineItemTaxLineRepository`
|
|
|
|
#### Defined in
|
|
|
|
[packages/medusa/src/services/line-item.ts:38](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/line-item.ts#L38)
|
|
|
|
___
|
|
|
|
### lineItemAdjustmentService\_
|
|
|
|
• `Protected` `Readonly` **lineItemAdjustmentService\_**: `LineItemAdjustmentService`
|
|
|
|
#### Defined in
|
|
|
|
[packages/medusa/src/services/line-item.ts:43](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/line-item.ts#L43)
|
|
|
|
___
|
|
|
|
### lineItemRepository\_
|
|
|
|
• `Protected` `Readonly` **lineItemRepository\_**: typeof `LineItemRepository`
|
|
|
|
#### Defined in
|
|
|
|
[packages/medusa/src/services/line-item.ts:37](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/line-item.ts#L37)
|
|
|
|
___
|
|
|
|
### manager\_
|
|
|
|
• `Protected` `Readonly` **manager\_**: `EntityManager`
|
|
|
|
#### Defined in
|
|
|
|
[packages/medusa/src/services/line-item.ts:36](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/line-item.ts#L36)
|
|
|
|
___
|
|
|
|
### productService\_
|
|
|
|
• `Protected` `Readonly` **productService\_**: [`ProductService`](ProductService.md)
|
|
|
|
#### Defined in
|
|
|
|
[packages/medusa/src/services/line-item.ts:41](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/line-item.ts#L41)
|
|
|
|
___
|
|
|
|
### productVariantService\_
|
|
|
|
• `Protected` `Readonly` **productVariantService\_**: [`ProductVariantService`](ProductVariantService.md)
|
|
|
|
#### Defined in
|
|
|
|
[packages/medusa/src/services/line-item.ts:40](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/line-item.ts#L40)
|
|
|
|
___
|
|
|
|
### regionService\_
|
|
|
|
• `Protected` `Readonly` **regionService\_**: [`RegionService`](RegionService.md)
|
|
|
|
#### Defined in
|
|
|
|
[packages/medusa/src/services/line-item.ts:42](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/line-item.ts#L42)
|
|
|
|
## 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](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/line-item.ts#L267)
|
|
|
|
___
|
|
|
|
### 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](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/line-item.ts#L139)
|
|
|
|
___
|
|
|
|
### 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](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/line-item.ts#L315)
|
|
|
|
___
|
|
|
|
### 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](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/line-item.ts#L192)
|
|
|
|
___
|
|
|
|
### 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](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/line-item.ts#L91)
|
|
|
|
___
|
|
|
|
### 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](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/line-item.ts#L111)
|
|
|
|
___
|
|
|
|
### 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](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/line-item.ts#L286)
|
|
|
|
___
|
|
|
|
### withTransaction
|
|
|
|
▸ **withTransaction**(`transactionManager`): [`LineItemService`](LineItemService.md)
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `transactionManager` | `EntityManager` |
|
|
|
|
#### Returns
|
|
|
|
[`LineItemService`](LineItemService.md)
|
|
|
|
#### Defined in
|
|
|
|
[packages/medusa/src/services/line-item.ts:69](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/line-item.ts#L69)
|