272 lines
18 KiB
Plaintext
272 lines
18 KiB
Plaintext
---
|
|
displayed_sidebar: servicesSidebar
|
|
---
|
|
|
|
import ParameterTypes from "@site/src/components/ParameterTypes"
|
|
|
|
# OrderEditService
|
|
|
|
## constructor
|
|
|
|
### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
___
|
|
|
|
## Properties
|
|
|
|
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBusService_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItemAdjustmentService_","type":"[LineItemAdjustmentService](services.LineItemAdjustmentService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItemService_","type":"[LineItemService](services.LineItemService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"newTotalsService_","type":"[NewTotalsService](services.NewTotalsService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orderEditItemChangeService_","type":"[OrderEditItemChangeService](services.OrderEditItemChangeService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orderEditRepository_","type":"Repository<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orderService_","type":"[OrderService](services.OrderService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"taxProviderService_","type":"[TaxProviderService](services.TaxProviderService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"totalsService_","type":"[TotalsService](services.TotalsService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events.CANCELED","type":"`string`","description":"","optional":false,"defaultValue":"\"order-edit.canceled\"","expandable":false,"children":[]},{"name":"Events.CONFIRMED","type":"`string`","description":"","optional":false,"defaultValue":"\"order-edit.confirmed\"","expandable":false,"children":[]},{"name":"Events.CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"order-edit.created\"","expandable":false,"children":[]},{"name":"Events.DECLINED","type":"`string`","description":"","optional":false,"defaultValue":"\"order-edit.declined\"","expandable":false,"children":[]},{"name":"Events.REQUESTED","type":"`string`","description":"","optional":false,"defaultValue":"\"order-edit.requested\"","expandable":false,"children":[]},{"name":"Events.UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"order-edit.updated\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
___
|
|
|
|
## Accessors
|
|
|
|
### activeManager\_
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### inventoryService\_
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"undefined \\| IInventoryService","type":"`undefined` \\| [IInventoryService](../../inventory/interfaces/inventory.IInventoryService.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
___
|
|
|
|
## Methods
|
|
|
|
### addLineItem
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"orderEditId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`AddOrderEditLineItemInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### atomicPhase\_
|
|
|
|
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
|
|
|
|
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise<TResult>","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: TError) => Promise<void \\| TResult>","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: TError) => Promise<void \\| TResult>","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
|
|
|
### cancel
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"orderEditId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`object`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"context.canceledBy","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### confirm
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"orderEditId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`object`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"context.confirmedBy","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### create
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"data","type":"`CreateOrderEditInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context.createdBy","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### decline
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"orderEditId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context.declinedBy","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context.declinedReason","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### decorateTotals
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"orderEdit","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### delete
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### deleteClonedItems
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"orderEditId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### deleteItemChange
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"orderEditId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"itemChangeId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### list
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### listAndCount
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)> & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[], number]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### refreshAdjustments
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"orderEditId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config.preserveCustomAdjustments","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### removeLineItem
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"orderEditId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItemId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### requestConfirmation
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"orderEditId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`object`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"context.requestedBy","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### retrieve
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"orderEditId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### retrieveActive
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"orderId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<undefined \\| null \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### shouldRetryTransaction\_
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### update
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"orderEditId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"DeepPartial<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### updateLineItem
|
|
|
|
Create or update order edit item change line item and apply the quantity
|
|
- If the item change already exists then update the quantity of the line item as well as the line adjustments
|
|
- If the item change does not exist then create the item change of type update and apply the quantity as well as update the line adjustments
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"orderEditId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"itemId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data.quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Create or update order edit item change line item and apply the quantity\n- If the item change already exists then update the quantity of the line item as well as the line adjustments\n- If the item change does not exist then create the item change of type update and apply the quantity as well as update the line adjustments","expandable":false,"children":[]}]} />
|
|
|
|
### withTransaction
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"this","type":"`this`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
|
|
|
### isOrderEditActive
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[{"name":"orderEdit","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
|
|
|
#### Returns
|
|
|
|
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|