Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

updateReturnWorkflow - Medusa Core Workflows Reference

This documentation provides a reference to the updateReturnWorkflow. It belongs to the @medusajs/medusa/core-flows package.

This workflow updates a return's details. It's used by the Update Return Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to update a return in your custom flow.

Source Code

Examples#

Steps#

useRemoteQueryStep

useRemoteQueryStep

updateReturnValidationStep

updateReturnsStep

previewOrderChangeStep

Workflow Hook

Step conditioned by when

Input#

UpdateReturnWorkflowInputUpdateReturnWorkflowInput
return_idstring
The ID of the return to update.
location_idnull | stringOptional
The ID of the stock location that items are returned to.
no_notificationbooleanOptional
Whether to notify the customer about the return update.
metadatanull | Record<string, any>Optional
Custom key-value pairs of data to store in the return.

Output#

OrderPreviewDTOOrderPreviewDTO
The details of an order after a change is applied on it.
idstring
The ID of the order.
versionnumber
The version of the order.
display_idnumber
The order's display ID.
statusOrderStatus
The status of the order.
currency_codestring
The currency of the order
created_atstring | Date
When the order was created.
updated_atstring | Date
When the order was updated.
original_item_totalBigNumberValue
The original item total of the order.
original_item_subtotalBigNumberValue
The original item subtotal of the order.
original_item_tax_totalBigNumberValue
The original item tax total of the order.
item_totalBigNumberValue
The item total of the order.
item_subtotalBigNumberValue
The item subtotal of the order.
item_tax_totalBigNumberValue
The item tax total of the order.
original_totalBigNumberValue
The original total of the order.
original_subtotalBigNumberValue
The original subtotal of the order.
original_tax_totalBigNumberValue
The original tax total of the order.
totalBigNumberValue
The total of the order.
subtotalBigNumberValue
The subtotal of the order. (Excluding taxes)
tax_totalBigNumberValue
The tax total of the order.
discount_subtotalBigNumberValue
The discount subtotal of the order.
discount_totalBigNumberValue
The discount total of the order.
discount_tax_totalBigNumberValue
The discount tax total of the order.
gift_card_totalBigNumberValue
The gift card total of the order.
gift_card_tax_totalBigNumberValue
The gift card tax total of the order.
shipping_totalBigNumberValue
The shipping total of the order.
shipping_subtotalBigNumberValue
The shipping subtotal of the order.
shipping_tax_totalBigNumberValue
The shipping tax total of the order.
original_shipping_totalBigNumberValue
The original shipping total of the order.
original_shipping_subtotalBigNumberValue
The original shipping subtotal of the order.
original_shipping_tax_totalBigNumberValue
The original shipping tax total of the order.
raw_original_item_totalBigNumberRawValue
The raw original item total of the order.
raw_original_item_subtotalBigNumberRawValue
The raw original item subtotal of the order.
raw_original_item_tax_totalBigNumberRawValue
The raw original item tax total of the order.
raw_item_totalBigNumberRawValue
The raw item total of the order.
raw_item_subtotalBigNumberRawValue
The raw item subtotal of the order.
raw_item_tax_totalBigNumberRawValue
The raw item tax total of the order.
raw_original_totalBigNumberRawValue
The raw original total of the order.
raw_original_subtotalBigNumberRawValue
The raw original subtotal of the order.
raw_original_tax_totalBigNumberRawValue
The raw original tax total of the order.
raw_totalBigNumberRawValue
The raw total of the order.
raw_subtotalBigNumberRawValue
The raw subtotal of the order. (Excluding taxes)
raw_tax_totalBigNumberRawValue
The raw tax total of the order.
raw_discount_totalBigNumberRawValue
The raw discount total of the order.
raw_discount_tax_totalBigNumberRawValue
The raw discount tax total of the order.
raw_gift_card_totalBigNumberRawValue
The raw gift card total of the order.
raw_gift_card_tax_totalBigNumberRawValue
The raw gift card tax total of the order.
raw_shipping_totalBigNumberRawValue
The raw shipping total of the order.
raw_shipping_subtotalBigNumberRawValue
The raw shipping subtotal of the order.
raw_shipping_tax_totalBigNumberRawValue
The raw shipping tax total of the order.
raw_original_shipping_totalBigNumberRawValue
The raw original shipping total of the order.
raw_original_shipping_subtotalBigNumberRawValue
The raw original shipping subtotal of the order.
raw_original_shipping_tax_totalBigNumberRawValue
The raw original shipping tax total of the order.
order_changeOrderChangeDTO
The details of the changes made on the order.
itemsOrderLineItemDTO & object[]
The items of the order, along with changes on the items.
shipping_methodsOrderShippingMethodDTO & object[]
The shipping methods of the order, along with changes on the shipping methods.
return_requested_totalnumber
The total amount for the requested return.
region_idstringOptional
The ID of the region the order belongs to.
customer_idstringOptional
The ID of the customer on the order.
sales_channel_idstringOptional
The ID of the sales channel the order belongs to.
emailstringOptional
The email of the order.
shipping_addressOrderAddressDTOOptional
The associated shipping address.
billing_addressOrderAddressDTOOptional
The associated billing address.
transactionsOrderTransactionDTO[]Optional
The tramsactions associated with the order
credit_linesOrderCreditLineDTO[]Optional
The credit lines for an order
summaryOrderSummaryDTOOptional
The summary of the order totals.
metadatanull | Record<string, unknown>Optional
Holds custom data in key-value pairs.
canceled_atstring | DateOptional
When the order was canceled.
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
⇧↵