FAQWhat 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?
RecipesHow 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 updateOrderChangesStep - Medusa Core Workflows Reference - Medusa DocumentationupdateOrderChangesStep - Medusa Core Workflows Reference
This documentation provides a reference to the updateOrderChangesStep
. It belongs to the @medusajs/medusa/core-flows
package.
This step updates order change.
src/workflows/my-workflow.ts
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { updateOrderChangesStep } from "@medusajs/medusa/core-flows"3
4const myWorkflow = createWorkflow(5 "my-workflow",6 () => {7 const data = updateOrderChangesStep({8 "id": "id_Efe67d2Pdn"9 })10 }11)
The order changes to update.
The ID of the order change.
The status of the order change.
description
stringOptional
The description of the order change.
return_id
null | stringOptional
The associated return's ID.
internal_note
null | stringOptional
The internal note of the order change.
requested_by
null | stringOptional
The user or customer that requested the
order change.
requested_at
null | DateOptional
The date the order change was requested.
confirmed_by
null | stringOptional
The user or customer that confirmed the
order change.
confirmed_at
null | DateOptional
The date the order change was confirmed.
declined_by
null | stringOptional
The user or customer that declined
the order change.
declined_reason
null | stringOptional
The reason that the order change was declined.
declined_at
null | DateOptional
The date that the order change was declined.
canceled_by
null | stringOptional
The user or customer that canceled the
order change.
canceled_at
null | DateOptional
The date that the order change was canceled.
metadata
null | Record<string, unknown>Optional
Holds custom data in key-value pairs.
Output#
The ID of the order change
The version of the order change
The ID of the associated order
The ID of the associated return order
The ID of the associated exchange order
The ID of the associated claim order
The associated order
The associated return order
The associated exchange order
The associated claim order
The actions of the order change
The status of the order change
requested_by
null | string
The requested by of the order change
requested_at
null | string | Date
When the order change was requested
confirmed_by
null | string
The confirmed by of the order change
confirmed_at
null | string | Date
When the order change was confirmed
The declined by of the order change
declined_reason
null | string
The declined reason of the order change
metadata
null | Record<string, unknown>
The metadata of the order change
declined_at
null | string | Date
When the order change was declined
The canceled by of the order change
canceled_at
null | string | Date
When the order change was canceled
When the order change was created
When the order change was updated
change_type
"return" | "exchange" | "claim" | "edit" | "transfer"Optional
The type of the order change