Menu

createOrderChangeStep - Medusa Core Workflows Reference

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

This step creates an order change.

src/workflows/my-workflow.ts
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { createOrderChangeStep } from "@medusajs/medusa/core-flows"3
4const myWorkflow = createWorkflow(5  "my-workflow",6  () => {7    const data = createOrderChangeStep({8      "order_id": "order_123"9    })10  }11)

Input#

CreateOrderChangeDTOCreateOrderChangeDTO
The data of the order change to be created.
order_idstring
The associated order's ID.
return_idstringOptional
The associated return's ID.
claim_idstringOptional
The associated claim's ID.
exchange_idstringOptional
The associated exchange's ID.
change_typeOrderChangeTypeOptional
The type of the order change.
descriptionstringOptional
The description of the order change.
internal_notenull | stringOptional
The internal note of the order change.
requested_bystringOptional
The user or customer that requested the order change.
requested_atDateOptional
The date that the order change was requested.
created_bynull | stringOptional
The user that created the order change.
metadatanull | Record<string, unknown>Optional
Holds custom data in key-value pairs.
actionsCreateOrderChangeActionDTO[]Optional
The actions of the order change.

Output#

OrderChangeDTOOrderChangeDTO
The order change details.
idstring
The ID of the order change
versionnumber
The version of the order change
order_idstring
The ID of the associated order
return_idstring
The ID of the associated return order
exchange_idstring
The ID of the associated exchange order
claim_idstring
The ID of the associated claim order
orderOrderDTO
The associated order
return_orderReturnDTO
The associated return order
exchangeOrderExchangeDTO
The associated exchange order
claimOrderClaimDTO
The associated claim order
actionsOrderChangeActionDTO[]
The actions of the order change
statusOrderChangeStatus
The status of the order change
requested_bynull | string
The requested by of the order change
requested_atnull | string | Date
When the order change was requested
confirmed_bynull | string
The confirmed by of the order change
confirmed_atnull | string | Date
When the order change was confirmed
declined_bynull | string
The declined by of the order change
declined_reasonnull | string
The declined reason of the order change
metadatanull | Record<string, unknown>
The metadata of the order change
declined_atnull | string | Date
When the order change was declined
canceled_bynull | string
The canceled by of the order change
canceled_atnull | string | Date
When the order change was canceled
created_atstring | Date
When the order change was created
updated_atstring | Date
When the order change was updated
change_type"return" | "exchange" | "claim" | "edit" | "transfer"Optional
The type of the order change
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
⇧↵