updateReturnReasons - Order Module Reference

This documentation provides a reference to the updateReturnReasons 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.

updateReturnReasons(selector, data, sharedContext?): Promise<OrderReturnReasonDTO[]>#

This method updates existing return reasons matching the specified filters.

Example#

Code
1const returnReasons = await orderModuleService.updateReturnReasons({2  id: "123"3}, {4  label: "Damaged"5})

Parameters#

The filters specifying which return reason to delete.
The data to update in the return reasons.
sharedContextContextOptional
A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<OrderReturnReasonDTO[]>
The updated return reasons.

updateReturnReasons(id, data, sharedContext?): Promise<OrderReturnReasonDTO>#

This method updates an existing return reason.

Example#

Code
1const returnReason = await orderModuleService.updateReturnReasons(2  "123",3  {4    label: "Damaged"5  }6)

Parameters#

idstring
The ID of the return reason.
The data to update in the return reason.
sharedContextContextOptional
A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<OrderReturnReasonDTO>
The updated return reason.
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