updateOrderChangesStep - 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.
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_zdBmwCEQrMaOrdaAPuTC"9 })10 }11)
Input#
UpdateOrderChangesStepInputUpdateOrderChangesStepInputThe order changes to update.
UpdateOrderChangesStepInputUpdateOrderChangesStepInputidstringThe ID of the order change.
idstringstatusstringOptionalThe status of the order change.
statusstringOptionaldescriptionstringOptionalThe description of the order change.
descriptionstringOptionalreturn_idnull | stringOptionalThe associated return's ID.
return_idnull | stringOptionalinternal_notenull | stringOptionalThe internal note of the order change.
internal_notenull | stringOptionalrequested_bynull | stringOptionalThe user or customer that requested the
order change.
requested_bynull | stringOptionalrequested_atnull | DateOptionalThe date the order change was requested.
requested_atnull | DateOptionalconfirmed_bynull | stringOptionalThe user or customer that confirmed the
order change.
confirmed_bynull | stringOptionalconfirmed_atnull | DateOptionalThe date the order change was confirmed.
confirmed_atnull | DateOptionaldeclined_bynull | stringOptionalThe user or customer that declined
the order change.
declined_bynull | stringOptionaldeclined_reasonnull | stringOptionalThe reason that the order change was declined.
declined_reasonnull | stringOptionaldeclined_atnull | DateOptionalThe date that the order change was declined.
declined_atnull | DateOptionalcanceled_bynull | stringOptionalThe user or customer that canceled the
order change.
canceled_bynull | stringOptionalcanceled_atnull | DateOptionalThe date that the order change was canceled.
canceled_atnull | DateOptionalmetadatanull | Record<string, unknown>OptionalHolds custom data in key-value pairs.
metadatanull | Record<string, unknown>OptionalOutput#
OrderChangeDTO[]OrderChangeDTO[]
OrderChangeDTO[]OrderChangeDTO[]idstringThe ID of the order change
idstringversionnumberThe version of the order change
versionnumberorder_idstringThe ID of the associated order
order_idstringreturn_idstringThe ID of the associated return order
return_idstringexchange_idstringThe ID of the associated exchange order
exchange_idstringclaim_idstringThe ID of the associated claim order
claim_idstringThe associated order
The associated return order
The associated exchange order
The associated claim order
The actions of the order change
statusOrderChangeStatusThe status of the order change
statusOrderChangeStatusrequested_bynull | stringThe requested by of the order change
requested_bynull | stringrequested_atnull | string | DateWhen the order change was requested
requested_atnull | string | Dateconfirmed_bynull | stringThe confirmed by of the order change
confirmed_bynull | stringconfirmed_atnull | string | DateWhen the order change was confirmed
confirmed_atnull | string | Datedeclined_bynull | stringThe declined by of the order change
declined_bynull | stringdeclined_reasonnull | stringThe declined reason of the order change
declined_reasonnull | stringmetadatanull | Record<string, unknown>The metadata of the order change
metadatanull | Record<string, unknown>declined_atnull | string | DateWhen the order change was declined
declined_atnull | string | Datecanceled_bynull | stringThe canceled by of the order change
canceled_bynull | stringcanceled_atnull | string | DateWhen the order change was canceled
canceled_atnull | string | Datecreated_atstring | DateWhen the order change was created
created_atstring | Dateupdated_atstring | DateWhen the order change was updated
updated_atstring | Datechange_type"return" | "exchange" | "claim" | "edit" | "transfer"OptionalThe type of the order change
change_type"return" | "exchange" | "claim" | "edit" | "transfer"OptionalWas this page helpful?