deleteOrderLineItems - Order Module Reference

This documentation provides a reference to the deleteOrderLineItems method. This belongs to the Order Module.

NoteYou should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

deleteOrderLineItems(itemIds, sharedContext?): Promise<void>#

This method deletes line items by their IDs.

Example#

Code
1await orderModuleService.deleteOrderLineItems([2  "123", "321"3])

Parameters#

itemIdsstring[]
The IDs of the line items to delete.
sharedContextContextOptional
A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<void>
Resolves when the line items are deleted successfully.

deleteOrderLineItems(itemId, sharedContext?): Promise<void>#

This method deletes a line item by its ID.

Example#

Code
await orderModuleService.deleteOrderLineItems("123")

Parameters#

itemIdstring
The line item's ID.
sharedContextContextOptional
A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<void>
Resolves when the line item is deleted successfully.

deleteOrderLineItems(selector, sharedContext?): Promise<void>#

This method deletes line items that match the specified filters.

Example#

Code
1await orderModuleService.deleteOrderLineItems({2  id: ["123", "321"]3})

Parameters#

The filters specifying which line items to delete.
sharedContextContextOptional
A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<void>
Resolves when the line items are deleted successfully.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break