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.

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_Pl4hkWpVjpNb6"9    })10  }11)

Input#

UpdateOrderChangesStepInputUpdateOrderChangesStepInput

The order changes to update.

idstring

The ID of the order change.

statusstringOptional

The status of the order change.

descriptionstringOptional

The description of the order change.

return_idnull | stringOptional

The associated return's ID.

internal_notenull | stringOptional

The internal note of the order change.

requested_bynull | stringOptional

The user or customer that requested the order change.

requested_atnull | DateOptional

The date the order change was requested.

confirmed_bynull | stringOptional

The user or customer that confirmed the order change.

confirmed_atnull | DateOptional

The date the order change was confirmed.

declined_bynull | stringOptional

The user or customer that declined the order change.

declined_reasonnull | stringOptional

The reason that the order change was declined.

declined_atnull | DateOptional

The date that the order change was declined.

canceled_bynull | stringOptional

The user or customer that canceled the order change.

canceled_atnull | DateOptional

The date that the order change was canceled.

metadatanull | Record<string, unknown>Optional

Holds custom data in key-value pairs.

Output#

OrderChangeDTO[]OrderChangeDTO[]

OrderChangeDTOOrderChangeDTO

The order change details.

Was this page helpful?