Skip to main content

Class: DraftOrderService

Handles draft orders

ImplementsCopy to Clipboard

Hierarchy​

  • TransactionBaseServiceCopy to Clipboard

    ↳ DraftOrderServiceCopy to Clipboard

Constructors​

constructor​

• new DraftOrderService(__namedParametersCopy to Clipboard)

Parameters​

NameType
__namedParametersCopy to ClipboardInjectedDependenciesCopy to Clipboard

Overrides​

TransactionBaseService.constructor

Defined in​

medusa/src/services/draft-order.ts:67

Properties​

__configModule__​

• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __configModule__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Inherited from​

TransactionBaseService.__configModule__

Defined in​

medusa/src/interfaces/transaction-base-service.ts:14

__container__​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard __container__: anyCopy to Clipboard

Inherited from​

TransactionBaseService.__container__

Defined in​

medusa/src/interfaces/transaction-base-service.ts:13

__moduleDeclaration__​

• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __moduleDeclaration__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Inherited from​

TransactionBaseService.__moduleDeclaration__

Defined in​

medusa/src/interfaces/transaction-base-service.ts:15

cartService_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard cartService_: CartServiceCopy to Clipboard

Defined in​

medusa/src/services/draft-order.ts:61

customShippingOptionService_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard customShippingOptionService_: CustomShippingOptionServiceCopy to Clipboard

Defined in​

medusa/src/services/draft-order.ts:65

draftOrderRepository_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard draftOrderRepository_: RepositoryCopy to Clipboard<DraftOrderCopy to Clipboard>

Defined in​

medusa/src/services/draft-order.ts:57

eventBus_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard eventBus_: EventBusServiceCopy to Clipboard

Defined in​

medusa/src/services/draft-order.ts:60

lineItemService_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard lineItemService_: LineItemServiceCopy to Clipboard

Defined in​

medusa/src/services/draft-order.ts:62

manager_​

• ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard

Inherited from​

TransactionBaseService.manager_

Defined in​

medusa/src/interfaces/transaction-base-service.ts:5

orderRepository_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard orderRepository_: RepositoryCopy to Clipboard<OrderCopy to Clipboard> & { findOneWithRelationsCopy to Clipboard: (relationsCopy to Clipboard: FindOptionsRelationsCopy to Clipboard<OrderCopy to Clipboard>, optionsWithoutRelationsCopy to Clipboard: OmitCopy to Clipboard<FindManyOptionsCopy to Clipboard<OrderCopy to Clipboard>, "relations"Copy to Clipboard>) => PromiseCopy to Clipboard<OrderCopy to Clipboard> ; findWithRelationsCopy to Clipboard: (relationsCopy to Clipboard: FindOptionsRelationsCopy to Clipboard<OrderCopy to Clipboard>, optionsWithoutRelationsCopy to Clipboard: OmitCopy to Clipboard<FindManyOptionsCopy to Clipboard<OrderCopy to Clipboard>, "relations"Copy to Clipboard>) => PromiseCopy to Clipboard<OrderCopy to Clipboard[]> }

Defined in​

medusa/src/services/draft-order.ts:59

paymentRepository_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard paymentRepository_: RepositoryCopy to Clipboard<PaymentCopy to Clipboard>

Defined in​

medusa/src/services/draft-order.ts:58

productVariantService_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard productVariantService_: ProductVariantServiceCopy to Clipboard

Defined in​

medusa/src/services/draft-order.ts:63

shippingOptionService_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard shippingOptionService_: ShippingOptionServiceCopy to Clipboard

Defined in​

medusa/src/services/draft-order.ts:64

transactionManager_​

• ProtectedCopy to Clipboard transactionManager_: undefinedCopy to Clipboard | EntityManagerCopy to Clipboard

Inherited from​

TransactionBaseService.transactionManager_

Defined in​

medusa/src/interfaces/transaction-base-service.ts:6

Events​

▪ StaticCopy to Clipboard ReadonlyCopy to Clipboard Events: ObjectCopy to Clipboard

Type declaration​

NameType
CREATEDCopy to ClipboardstringCopy to Clipboard
UPDATEDCopy to ClipboardstringCopy to Clipboard

Defined in​

medusa/src/services/draft-order.ts:52

Accessors​

activeManager_​

• ProtectedCopy to Clipboard getCopy to Clipboard activeManager_(): EntityManagerCopy to Clipboard

Returns​

EntityManagerCopy to Clipboard

Inherited from​

TransactionBaseService.activeManager_

Defined in​

medusa/src/interfaces/transaction-base-service.ts:8

Methods​

atomicPhase_​

▸ ProtectedCopy to Clipboard atomicPhase_<TResultCopy to Clipboard, TErrorCopy to Clipboard>(workCopy to Clipboard, isolationOrErrorHandler?Copy to Clipboard, maybeErrorHandlerOrDontFail?Copy to Clipboard): PromiseCopy to Clipboard<TResultCopy to Clipboard>

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​

Name
TResultCopy to Clipboard
TErrorCopy to Clipboard

Parameters​

NameTypeDescription
workCopy to Clipboard(transactionManagerCopy to Clipboard: EntityManagerCopy to Clipboard) => PromiseCopy to Clipboard<TResultCopy to Clipboard>the transactional work to be done
isolationOrErrorHandler?Copy to ClipboardIsolationLevelCopy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard>the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?Copy to Clipboard(errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard>Potential error handler

Returns​

PromiseCopy to Clipboard<TResultCopy to Clipboard>

the result of the transactional work

Inherited from​

TransactionBaseService.atomicPhase_

Defined in​

medusa/src/interfaces/transaction-base-service.ts:56

create​

▸ create(dataCopy to Clipboard): PromiseCopy to Clipboard<DraftOrderCopy to Clipboard>

Creates a draft order.

Parameters​

NameTypeDescription
dataCopy to ClipboardDraftOrderCreatePropsCopy to Clipboarddata to create draft order from

Returns​

PromiseCopy to Clipboard<DraftOrderCopy to Clipboard>

the created draft order

Defined in​

medusa/src/services/draft-order.ts:260

delete​

▸ delete(draftOrderIdCopy to Clipboard): PromiseCopy to Clipboard<undefinedCopy to Clipboard | DraftOrderCopy to Clipboard>

Deletes draft order idempotently.

Parameters​

NameTypeDescription
draftOrderIdCopy to ClipboardstringCopy to Clipboardid of draft order to delete

Returns​

PromiseCopy to Clipboard<undefinedCopy to Clipboard | DraftOrderCopy to Clipboard>

empty promise

Defined in​

medusa/src/services/draft-order.ts:156

list​

▸ list(selectorCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<DraftOrderCopy to Clipboard[]>

Lists draft orders

Parameters​

NameTypeDescription
selectorCopy to ClipboardanyCopy to Clipboardquery object for find
configCopy to ClipboardFindConfigCopy to Clipboard<DraftOrderCopy to Clipboard>configurable attributes for find

Returns​

PromiseCopy to Clipboard<DraftOrderCopy to Clipboard[]>

list of draft orders

Defined in​

medusa/src/services/draft-order.ts:238

listAndCount​

▸ listAndCount(selectorCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<[DraftOrderCopy to Clipboard[], numberCopy to Clipboard]>

Lists draft orders alongside the count

Parameters​

NameTypeDescription
selectorCopy to ClipboardanyCopy to Clipboardquery selector to filter draft orders
configCopy to ClipboardFindConfigCopy to Clipboard<DraftOrderCopy to Clipboard>query config

Returns​

PromiseCopy to Clipboard<[DraftOrderCopy to Clipboard[], numberCopy to Clipboard]>

draft orders

Defined in​

medusa/src/services/draft-order.ts:180

registerCartCompletion​

▸ registerCartCompletion(draftOrderIdCopy to Clipboard, orderIdCopy to Clipboard): PromiseCopy to Clipboard<UpdateResultCopy to Clipboard>

Registers a draft order as completed, when an order has been completed.

Parameters​

NameTypeDescription
draftOrderIdCopy to ClipboardstringCopy to Clipboardid of draft order to complete
orderIdCopy to ClipboardstringCopy to Clipboardid of order completed from draft order cart

Returns​

PromiseCopy to Clipboard<UpdateResultCopy to Clipboard>

the created order

Defined in​

medusa/src/services/draft-order.ts:421

retrieve​

▸ retrieve(draftOrderIdCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<DraftOrderCopy to Clipboard>

Retrieves a draft order with the given id.

Parameters​

NameTypeDescription
draftOrderIdCopy to ClipboardstringCopy to Clipboardid of the draft order to retrieve
configCopy to ClipboardFindConfigCopy to Clipboard<DraftOrderCopy to Clipboard>query object for findOne

Returns​

PromiseCopy to Clipboard<DraftOrderCopy to Clipboard>

the draft order

Defined in​

medusa/src/services/draft-order.ts:98

retrieveByCartId​

▸ retrieveByCartId(cartIdCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<DraftOrderCopy to Clipboard>

Retrieves a draft order based on its associated cart id

Parameters​

NameTypeDescription
cartIdCopy to ClipboardstringCopy to Clipboardcart id that the draft orders's cart has
configCopy to ClipboardFindConfigCopy to Clipboard<DraftOrderCopy to Clipboard>query object for findOne

Returns​

PromiseCopy to Clipboard<DraftOrderCopy to Clipboard>

the draft order

Defined in​

medusa/src/services/draft-order.ts:131

shouldRetryTransaction_​

▸ ProtectedCopy to Clipboard shouldRetryTransaction_(errCopy to Clipboard): booleanCopy to Clipboard

Parameters​

NameType
errCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | { codeCopy to Clipboard: stringCopy to Clipboard }

Returns​

booleanCopy to Clipboard

Inherited from​

TransactionBaseService.shouldRetryTransaction_

Defined in​

medusa/src/interfaces/transaction-base-service.ts:37

update​

▸ update(idCopy to Clipboard, dataCopy to Clipboard): PromiseCopy to Clipboard<DraftOrderCopy to Clipboard>

Updates a draft order with the given data

Parameters​

NameTypeDescription
idCopy to ClipboardstringCopy to Clipboardid of the draft order
dataCopy to ClipboardObjectCopy to Clipboardvalues to update the order with
data.no_notification_orderCopy to ClipboardbooleanCopy to Clipboard-

Returns​

PromiseCopy to Clipboard<DraftOrderCopy to Clipboard>

the updated draft order

Defined in​

medusa/src/services/draft-order.ts:450

withTransaction​

▸ withTransaction(transactionManager?Copy to Clipboard): DraftOrderServiceCopy to Clipboard

Parameters​

NameType
transactionManager?Copy to ClipboardEntityManagerCopy to Clipboard

Returns​

DraftOrderServiceCopy to Clipboard

Inherited from​

TransactionBaseService.withTransaction

Defined in​

medusa/src/interfaces/transaction-base-service.ts:20

Was this page helpful?
© 2023 Medusa, Inc. All rights reserved.