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

Class: DraftOrderService

Hierarchy

• TransactionBaseService<DraftOrderService>

  ↳ DraftOrderService

Constructors

constructor

• new DraftOrderService(__namedParameters)

Parameters

Name	Type
__namedParameters	InjectedDependencies

Overrides

TransactionBaseService<DraftOrderService&gt;.constructor

Defined in

services/draft-order.ts:51

Properties

cartService_

• Protected Readonly cartService_: CartService

Defined in

services/draft-order.ts:46

---

configModule

• Protected Optional Readonly configModule: Record<string, unknown>

Inherited from

TransactionBaseService.configModule

---

container

• Protected Readonly container: unknown

Inherited from

TransactionBaseService.container

---

draftOrderRepository_

• Protected Readonly draftOrderRepository_: typeof DraftOrderRepository

Defined in

services/draft-order.ts:42

---

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

services/draft-order.ts:45

---

lineItemService_

• Protected Readonly lineItemService_: LineItemService

Defined in

services/draft-order.ts:47

---

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

services/draft-order.ts:39

---

orderRepository_

• Protected Readonly orderRepository_: typeof OrderRepository

Defined in

services/draft-order.ts:44

---

paymentRepository_

• Protected Readonly paymentRepository_: typeof PaymentRepository

Defined in

services/draft-order.ts:43

---

productVariantService_

• Protected Readonly productVariantService_: ProductVariantService

Defined in

services/draft-order.ts:48

---

shippingOptionService_

• Protected Readonly shippingOptionService_: ShippingOptionService

Defined in

services/draft-order.ts:49

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

services/draft-order.ts:40

---

Events

▪ Static Readonly Events: Object

Type declaration

Name	Type
CREATED	string
UPDATED	string

Defined in

services/draft-order.ts:34

Methods

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Type parameters

Name
TResult
TError

Parameters

Name	Type	Description
work	(transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

Inherited from

TransactionBaseService.atomicPhase_

Defined in

interfaces/transaction-base-service.ts:53

---

create

▸ create(data): Promise<DraftOrder>

Parameters

Name	Type	Description
data	AdminPostDraftOrdersReq

Returns

Promise<DraftOrder>

Defined in

services/draft-order.ts:257

---

delete

▸ delete(draftOrderId): Promise<undefined | DraftOrder>

Parameters

Name	Type	Description
draftOrderId	string

Returns

Promise<undefined | DraftOrder>

Defined in

services/draft-order.ts:150

---

list

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

Parameters

Name	Type	Description
selector	any
config	FindConfig<DraftOrder>

Returns

Promise<DraftOrder[]>

Defined in

services/draft-order.ts:231

---

listAndCount

▸ listAndCount(selector, config?): Promise<[DraftOrder[], number]>

Parameters

Name	Type	Description
selector	any
config	FindConfig<DraftOrder>

Returns

Promise<[DraftOrder[], number]>

Defined in

services/draft-order.ts:174

---

registerCartCompletion

▸ registerCartCompletion(draftOrderId, orderId): Promise<UpdateResult>

Parameters

Name	Type	Description
draftOrderId	string
orderId	string

Returns

Promise<UpdateResult>

Defined in

services/draft-order.ts:363

---

retrieve

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

Parameters

Name	Type	Description
id	string
config	FindConfig<DraftOrder>

Returns

Promise<DraftOrder>

Defined in

services/draft-order.ts:91

---

retrieveByCartId

▸ retrieveByCartId(cartId, config?): Promise<DraftOrder>

Parameters

Name	Type	Description
cartId	string
config	FindConfig<DraftOrder>

Returns

Promise<DraftOrder>

Defined in

services/draft-order.ts:121

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
err	Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

interfaces/transaction-base-service.ts:34

---

update

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

Parameters

Name	Type	Description
id	string
data	Object
data.no_notification_order	boolean	-

Returns

Promise<DraftOrder>

Defined in

services/draft-order.ts:392

---

withTransaction

▸ withTransaction(transactionManager?): DraftOrderService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

DraftOrderService

Inherited from

TransactionBaseService.withTransaction

Defined in

interfaces/transaction-base-service.ts:16