updateOrderChangeActionsStep - Medusa Core Workflows Reference

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

This step updates order change actions.

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

Input#

UpdateOrderChangeActionsStepInputUpdateOrderChangeActionsStepInput

The order change actions to update.

idstring

The ID of the order change action.

internal_notenull | stringOptional

The internal note of the order change action.

Output#

OrderChangeActionDTO[]OrderChangeActionDTO[]

idstring

The ID of the order change action

order_change_idnull | string

The ID of the associated order change

order_changenull | OrderChangeDTO

The associated order change

order_idnull | string

The ID of the associated order

return_idnull | string

The ID of the associated return.

claim_idnull | string

The ID of the associated claim.

exchange_idnull | string

The ID of the associated exchange.

ordernull | OrderDTO

The associated order

referencestring

The reference of the order change action

reference_idstring

The ID of the reference

actionChangeActionType

The action of the order change action

detailsnull | Record<string, unknown>

The details of the order change action

internal_notenull | string

The internal note of the order change action

created_atstring | Date

When the order change action was created

updated_atstring | Date

When the order change action was updated

Was this page helpful?