Class: OrderService
Hierarchy
TransactionBaseServiceCopy to Clipboard↳
OrderServiceCopy to Clipboard
Constructors
constructor
• new OrderService(__namedParametersCopy to Clipboard)
Parameters
| Name | Type |
|---|---|
__namedParametersCopy to Clipboard | InjectedDependenciesCopy to Clipboard |
Overrides
TransactionBaseService.constructor
Defined in
packages/medusa/src/services/order.ts:125
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
packages/medusa/src/interfaces/transaction-base-service.ts:10
__container__
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard __container__: anyCopy to Clipboard
Inherited from
TransactionBaseService.__container__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:9
__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
packages/medusa/src/interfaces/transaction-base-service.ts:11
addressRepository_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard addressRepository_: typeof AddressRepositoryCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:117
cartService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard cartService_: CartServiceCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:116
customerService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard customerService_: CustomerServiceCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:104
discountService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard discountService_: DiscountServiceCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:108
draftOrderService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard draftOrderService_: DraftOrderServiceCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:119
eventBus_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard eventBus_: EventBusServiceCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:120
featureFlagRouter_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard featureFlagRouter_: FlagRouterCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:121
fulfillmentProviderService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard fulfillmentProviderService_: FulfillmentProviderServiceCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:109
fulfillmentService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard fulfillmentService_: FulfillmentServiceCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:110
giftCardService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard giftCardService_: GiftCardServiceCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:118
lineItemService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard lineItemService_: LineItemServiceCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:111
manager_
• ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard
Overrides
TransactionBaseService.manager_
Defined in
packages/medusa/src/services/order.ts:100
newTotalsService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard newTotalsService_: NewTotalsServiceCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:113
orderRepository_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard orderRepository_: typeof OrderRepositoryCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:103
paymentProviderService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard paymentProviderService_: PaymentProviderServiceCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:105
productVariantInventoryService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard productVariantInventoryService_: ProductVariantInventoryServiceCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:123
regionService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard regionService_: RegionServiceCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:115
shippingOptionService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard shippingOptionService_: ShippingOptionServiceCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:106
shippingProfileService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard shippingProfileService_: ShippingProfileServiceCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:107
taxProviderService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard taxProviderService_: TaxProviderServiceCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:114
totalsService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard totalsService_: TotalsServiceCopy to Clipboard
Defined in
packages/medusa/src/services/order.ts:112
transactionManager_
• ProtectedCopy to Clipboard transactionManager_: EntityManagerCopy to Clipboard
Overrides
TransactionBaseService.transactionManager_
Defined in
packages/medusa/src/services/order.ts:101
Events
▪ StaticCopy to Clipboard ReadonlyCopy to Clipboard Events: ObjectCopy to Clipboard
Type declaration
| Name | Type |
|---|---|
CANCELEDCopy to Clipboard | stringCopy to Clipboard |
COMPLETEDCopy to Clipboard | stringCopy to Clipboard |
FULFILLMENT_CANCELEDCopy to Clipboard | stringCopy to Clipboard |
FULFILLMENT_CREATEDCopy to Clipboard | stringCopy to Clipboard |
GIFT_CARD_CREATEDCopy to Clipboard | stringCopy to Clipboard |
ITEMS_RETURNEDCopy to Clipboard | stringCopy to Clipboard |
PAYMENT_CAPTUREDCopy to Clipboard | stringCopy to Clipboard |
PAYMENT_CAPTURE_FAILEDCopy to Clipboard | stringCopy to Clipboard |
PLACEDCopy to Clipboard | stringCopy to Clipboard |
REFUND_CREATEDCopy to Clipboard | stringCopy to Clipboard |
REFUND_FAILEDCopy to Clipboard | stringCopy to Clipboard |
RETURN_ACTION_REQUIREDCopy to Clipboard | stringCopy to Clipboard |
RETURN_REQUESTEDCopy to Clipboard | stringCopy to Clipboard |
SHIPMENT_CREATEDCopy to Clipboard | stringCopy to Clipboard |
SWAP_CREATEDCopy to Clipboard | stringCopy to Clipboard |
UPDATEDCopy to Clipboard | stringCopy to Clipboard |
Defined in
packages/medusa/src/services/order.ts:81
Methods
addShippingMethod
▸ addShippingMethod(orderIdCopy to Clipboard, optionIdCopy to Clipboard, data?Copy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
orderIdCopy to Clipboard | stringCopy to Clipboard |
optionIdCopy to Clipboard | stringCopy to Clipboard |
data?Copy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> |
configCopy to Clipboard | CreateShippingMethodDtoCopy to Clipboard |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
Defined in
packages/medusa/src/services/order.ts:943
archive
▸ archive(orderIdCopy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Archives an order. It only alloved, if the order has been fulfilled and payment has been captured.
Parameters
| Name | Type | Description |
|---|---|---|
orderIdCopy to Clipboard | stringCopy to Clipboard | the order to archive |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
the result of the update operation
Defined in
packages/medusa/src/services/order.ts:1480
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
| Name | Type | Description |
|---|---|---|
workCopy to Clipboard | (transactionManagerCopy to Clipboard: EntityManagerCopy to Clipboard) => PromiseCopy to Clipboard<TResultCopy to Clipboard> | the transactional work to be done |
isolationOrErrorHandler?Copy to Clipboard | IsolationLevelCopy 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
packages/medusa/src/interfaces/transaction-base-service.ts:50
cancel
▸ cancel(orderIdCopy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Cancels an order. Throws if fulfillment process has been initiated. Throws if payment process has been initiated.
Parameters
| Name | Type | Description |
|---|---|---|
orderIdCopy to Clipboard | stringCopy to Clipboard | id of order to cancel. |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
result of the update operation.
Defined in
packages/medusa/src/services/order.ts:1095
cancelFulfillment
▸ cancelFulfillment(fulfillmentIdCopy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Cancels a fulfillment (if related to an order)
Parameters
| Name | Type | Description |
|---|---|---|
fulfillmentIdCopy to Clipboard | stringCopy to Clipboard | the ID of the fulfillment to cancel |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
updated order
Defined in
packages/medusa/src/services/order.ts:1417
capturePayment
▸ capturePayment(orderIdCopy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Captures payment for an order.
Parameters
| Name | Type | Description |
|---|---|---|
orderIdCopy to Clipboard | stringCopy to Clipboard | id of order to capture payment for. |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
result of the update operation.
Defined in
packages/medusa/src/services/order.ts:1184
completeOrder
▸ completeOrder(orderIdCopy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Parameters
| Name | Type | Description |
|---|---|---|
orderIdCopy to Clipboard | stringCopy to Clipboard | id of the order to complete |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
the result of the find operation
Defined in
packages/medusa/src/services/order.ts:513
createFromCart
▸ createFromCart(cartOrIdCopy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Creates an order from a cart
Parameters
| Name | Type |
|---|---|
cartOrIdCopy to Clipboard | stringCopy to Clipboard | CartCopy to Clipboard |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
resolves to the creation result.
Defined in
packages/medusa/src/services/order.ts:541
createFulfillment
▸ createFulfillment(orderIdCopy to Clipboard, itemsToFulfillCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Creates fulfillments for an order. In a situation where the order has more than one shipping method, we need to partition the order items, such that they can be sent to their respective fulfillment provider.
Parameters
| Name | Type | Description |
|---|---|---|
orderIdCopy to Clipboard | stringCopy to Clipboard | id of order to cancel. |
itemsToFulfillCopy to Clipboard | FulFillmentItemTypeCopy to Clipboard[] | items to fulfil. |
configCopy to Clipboard | ObjectCopy to Clipboard | the config to cancel. |
config.location_id?Copy to Clipboard | stringCopy to Clipboard | - |
config.metadata?Copy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | - |
config.no_notification?Copy to Clipboard | booleanCopy to Clipboard | - |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
result of the update operation.
Defined in
packages/medusa/src/services/order.ts:1289
createGiftCardsFromLineItem_
▸ ProtectedCopy to Clipboard createGiftCardsFromLineItem_(orderCopy to Clipboard, lineItemCopy to Clipboard, managerCopy to Clipboard): PromiseCopy to Clipboard<GiftCardCopy to Clipboard>[]
Parameters
| Name | Type |
|---|---|
orderCopy to Clipboard | OrderCopy to Clipboard |
lineItemCopy to Clipboard | LineItemCopy to Clipboard |
managerCopy to Clipboard | EntityManagerCopy to Clipboard |
Returns
PromiseCopy to Clipboard<GiftCardCopy to Clipboard>[]
Defined in
packages/medusa/src/services/order.ts:731
createRefund
▸ createRefund(orderIdCopy to Clipboard, refundAmountCopy to Clipboard, reasonCopy to Clipboard, note?Copy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Refunds a given amount back to the customer.
Parameters
| Name | Type | Description |
|---|---|---|
orderIdCopy to Clipboard | stringCopy to Clipboard | id of the order to refund. |
refundAmountCopy to Clipboard | numberCopy to Clipboard | the amount to refund. |
reasonCopy to Clipboard | stringCopy to Clipboard | the reason to refund. |
note?Copy to Clipboard | stringCopy to Clipboard | note for refund. |
configCopy to Clipboard | ObjectCopy to Clipboard | the config for refund. |
config.no_notification?Copy to Clipboard | booleanCopy to Clipboard | - |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
the result of the refund operation.
Defined in
packages/medusa/src/services/order.ts:1506
createShipment
▸ createShipment(orderIdCopy to Clipboard, fulfillmentIdCopy to Clipboard, trackingLinks?Copy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Adds a shipment to the order to indicate that an order has left the warehouse. Will ask the fulfillment provider for any documents that may have been created in regards to the shipment.
Parameters
| Name | Type | Description |
|---|---|---|
orderIdCopy to Clipboard | stringCopy to Clipboard | the id of the order that has been shipped |
fulfillmentIdCopy to Clipboard | stringCopy to Clipboard | the fulfillment that has now been shipped |
trackingLinks?Copy to Clipboard | TrackingLinkCopy to Clipboard[] | array of tracking numebers associated with the shipment |
configCopy to Clipboard | ObjectCopy to Clipboard | the config of the order that has been shipped |
config.metadataCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | - |
config.no_notification?Copy to Clipboard | booleanCopy to Clipboard | - |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
the resulting order following the update.
Defined in
packages/medusa/src/services/order.ts:785
decorateTotals
▸ decorateTotals(orderCopy to Clipboard, totalsFields?Copy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Calculate and attach the different total fields on the object
Parameters
| Name | Type |
|---|---|
orderCopy to Clipboard | OrderCopy to Clipboard |
totalsFields?Copy to Clipboard | stringCopy to Clipboard[] |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
Defined in
packages/medusa/src/services/order.ts:1701
▸ decorateTotals(orderCopy to Clipboard, context?Copy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Calculate and attach the different total fields on the object
Parameters
| Name | Type |
|---|---|
orderCopy to Clipboard | OrderCopy to Clipboard |
context?Copy to Clipboard | TotalsContextCopy to Clipboard |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
Defined in
packages/medusa/src/services/order.ts:1703
decorateTotalsLegacy
▸ ProtectedCopy to Clipboard decorateTotalsLegacy(orderCopy to Clipboard, totalsFields?Copy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Parameters
| Name | Type | Default value |
|---|---|---|
orderCopy to Clipboard | OrderCopy to Clipboard | undefinedCopy to Clipboard |
totalsFieldsCopy to Clipboard | stringCopy to Clipboard[] | []Copy to Clipboard |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
Defined in
packages/medusa/src/services/order.ts:1572
getFulfillmentItems
▸ ProtectedCopy to Clipboard getFulfillmentItems(orderCopy to Clipboard, itemsCopy to Clipboard, transformerCopy to Clipboard): PromiseCopy to Clipboard<LineItemCopy to Clipboard[]>
Retrieves the order line items, given an array of items.
Parameters
| Name | Type | Description |
|---|---|---|
orderCopy to Clipboard | OrderCopy to Clipboard | the order to get line items from |
itemsCopy to Clipboard | FulFillmentItemTypeCopy to Clipboard[] | the items to get |
transformerCopy to Clipboard | (itemCopy to Clipboard: undefinedCopy to Clipboard | LineItemCopy to Clipboard, quantityCopy to Clipboard: numberCopy to Clipboard) => unknownCopy to Clipboard | a function to apply to each of the items retrieved from the order, should return a line item. If the transformer returns an undefined value the line item will be filtered from the returned array. |
Returns
PromiseCopy to Clipboard<LineItemCopy to Clipboard[]>
the line items generated by the transformer.
Defined in
packages/medusa/src/services/order.ts:1459
getTotalsRelations
▸ PrivateCopy to Clipboard getTotalsRelations(configCopy to Clipboard): stringCopy to Clipboard[]
Parameters
| Name | Type |
|---|---|
configCopy to Clipboard | FindConfigCopy to Clipboard<OrderCopy to Clipboard> |
Returns
stringCopy to Clipboard[]
Defined in
packages/medusa/src/services/order.ts:1961
list
▸ list(selectorCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard[]>
Parameters
| Name | Type | Description |
|---|---|---|
selectorCopy to Clipboard | SelectorCopy to Clipboard<OrderCopy to Clipboard> | the query object for find |
configCopy to Clipboard | FindConfigCopy to Clipboard<OrderCopy to Clipboard> | the config to be used for find |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard[]>
the result of the find operation
Defined in
packages/medusa/src/services/order.ts:179
listAndCount
▸ listAndCount(selectorCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<[OrderCopy to Clipboard[], numberCopy to Clipboard]>
Parameters
| Name | Type | Description |
|---|---|---|
selectorCopy to Clipboard | QuerySelectorCopy to Clipboard<OrderCopy to Clipboard> | the query object for find |
configCopy to Clipboard | FindConfigCopy to Clipboard<OrderCopy to Clipboard> | the config to be used for find |
Returns
PromiseCopy to Clipboard<[OrderCopy to Clipboard[], numberCopy to Clipboard]>
the result of the find operation
Defined in
packages/medusa/src/services/order.ts:196
registerReturnReceived
▸ registerReturnReceived(orderIdCopy to Clipboard, receivedReturnCopy to Clipboard, customRefundAmount?Copy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Handles receiving a return. This will create a refund to the customer. If the returned items don't match the requested items the return status will be updated to requires_action. This behaviour is useful in sitautions where a custom refund amount is requested, but the retuned items are not matching the requested items. Setting the allowMismatch argument to true, will process the return, ignoring any mismatches.
Parameters
| Name | Type | Description |
|---|---|---|
orderIdCopy to Clipboard | stringCopy to Clipboard | the order to return. |
receivedReturnCopy to Clipboard | ReturnCopy to Clipboard | the received return |
customRefundAmount?Copy to Clipboard | numberCopy to Clipboard | the custom refund amount return |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
the result of the update operation
Defined in
packages/medusa/src/services/order.ts:1886
retrieve
▸ retrieve(orderIdCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Gets an order by id.
Parameters
| Name | Type | Description |
|---|---|---|
orderIdCopy to Clipboard | stringCopy to Clipboard | id or selector of order to retrieve |
configCopy to Clipboard | FindConfigCopy to Clipboard<OrderCopy to Clipboard> | config of order to retrieve |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
the order document
Defined in
packages/medusa/src/services/order.ts:339
retrieveByCartId
▸ retrieveByCartId(cartIdCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Gets an order by cart id.
Parameters
| Name | Type | Description |
|---|---|---|
cartIdCopy to Clipboard | stringCopy to Clipboard | cart id to find order |
configCopy to Clipboard | FindConfigCopy to Clipboard<OrderCopy to Clipboard> | the config to be used to find order |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
the order document
Defined in
packages/medusa/src/services/order.ts:435
retrieveByExternalId
▸ retrieveByExternalId(externalIdCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Gets an order by id.
Parameters
| Name | Type | Description |
|---|---|---|
externalIdCopy to Clipboard | stringCopy to Clipboard | id of order to retrieve |
configCopy to Clipboard | FindConfigCopy to Clipboard<OrderCopy to Clipboard> | query config to get order by |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
the order document
Defined in
packages/medusa/src/services/order.ts:476
retrieveLegacy
▸ ProtectedCopy to Clipboard retrieveLegacy(orderIdOrSelectorCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
orderIdOrSelectorCopy to Clipboard | stringCopy to Clipboard | SelectorCopy to Clipboard<OrderCopy to Clipboard> |
configCopy to Clipboard | FindConfigCopy to Clipboard<OrderCopy to Clipboard> |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
Defined in
packages/medusa/src/services/order.ts:380
retrieveWithTotals
▸ retrieveWithTotals(orderIdCopy to Clipboard, options?Copy to Clipboard, context?Copy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
orderIdCopy to Clipboard | stringCopy to Clipboard |
optionsCopy to Clipboard | FindConfigCopy to Clipboard<OrderCopy to Clipboard> |
contextCopy to Clipboard | TotalsContextCopy to Clipboard |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
Defined in
packages/medusa/src/services/order.ts:418
shouldRetryTransaction_
▸ ProtectedCopy to Clipboard shouldRetryTransaction_(errCopy to Clipboard): booleanCopy to Clipboard
Parameters
| Name | Type |
|---|---|
errCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | { codeCopy to Clipboard: stringCopy to Clipboard } |
Returns
booleanCopy to Clipboard
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:31
transformQueryForTotals
▸ ProtectedCopy to Clipboard transformQueryForTotals(configCopy to Clipboard): ObjectCopy to Clipboard
Parameters
| Name | Type |
|---|---|
configCopy to Clipboard | FindConfigCopy to Clipboard<OrderCopy to Clipboard> |
Returns
ObjectCopy to Clipboard
| Name | Type |
|---|---|
relationsCopy to Clipboard | undefinedCopy to Clipboard | stringCopy to Clipboard[] |
selectCopy to Clipboard | undefinedCopy to Clipboard | keyof OrderCopy to Clipboard[] |
totalsToSelectCopy to Clipboard | undefinedCopy to Clipboard | keyof OrderCopy to Clipboard[] |
Defined in
packages/medusa/src/services/order.ts:263
update
▸ update(orderIdCopy to Clipboard, updateCopy to Clipboard): PromiseCopy to Clipboard<OrderCopy to Clipboard>
Updates an order. Metadata updates should
use dedicated method, e.g. setMetadataCopy to Clipboard etc. The function
will throw errors if metadata updates are attempted.
Parameters
| Name | Type | Description |
|---|---|---|
orderIdCopy to Clipboard | stringCopy to Clipboard | the id of the order. Must be a string that can be casted to an ObjectId |
updateCopy to Clipboard | UpdateOrderInputCopy to Clipboard | an object with the update values. |
Returns
PromiseCopy to Clipboard<OrderCopy to Clipboard>
resolves to the update result.
Defined in
packages/medusa/src/services/order.ts:1006
updateBillingAddress
▸ ProtectedCopy to Clipboard updateBillingAddress(orderCopy to Clipboard, addressCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>
Updates the order's billing address.
Parameters
| Name | Type | Description |
|---|---|---|
orderCopy to Clipboard | OrderCopy to Clipboard | the order to update |
addressCopy to Clipboard | AddressCopy to Clipboard | the value to set the billing address to |
Returns
PromiseCopy to Clipboard<voidCopy to Clipboard>
the result of the update operation
Defined in
packages/medusa/src/services/order.ts:873
updateShippingAddress
▸ ProtectedCopy to Clipboard updateShippingAddress(orderCopy to Clipboard, addressCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>
Updates the order's shipping address.
Parameters
| Name | Type | Description |
|---|---|---|
orderCopy to Clipboard | OrderCopy to Clipboard | the order to update |
addressCopy to Clipboard | AddressCopy to Clipboard | the value to set the shipping address to |
Returns
PromiseCopy to Clipboard<voidCopy to Clipboard>
the result of the update operation
Defined in
packages/medusa/src/services/order.ts:912
validateFulfillmentLineItem
▸ ProtectedCopy to Clipboard validateFulfillmentLineItem(itemCopy to Clipboard, quantityCopy to Clipboard): nullCopy to Clipboard | LineItemCopy to Clipboard
Checks that a given quantity of a line item can be fulfilled. Fails if the fulfillable quantity is lower than the requested fulfillment quantity. Fulfillable quantity is calculated by subtracting the already fulfilled quantity from the quantity that was originally purchased.
Parameters
| Name | Type | Description |
|---|---|---|
itemCopy to Clipboard | LineItemCopy to Clipboard | the line item to check has sufficient fulfillable quantity. |
quantityCopy to Clipboard | numberCopy to Clipboard | the quantity that is requested to be fulfilled. |
Returns
nullCopy to Clipboard | LineItemCopy to Clipboard
a line item that has the requested fulfillment quantity set.
Defined in
packages/medusa/src/services/order.ts:1256
withTransaction
▸ withTransaction(transactionManager?Copy to Clipboard): OrderServiceCopy to Clipboard
Parameters
| Name | Type |
|---|---|
transactionManager?Copy to Clipboard | EntityManagerCopy to Clipboard |
Returns
Inherited from
TransactionBaseService.withTransaction
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:14