createOrderExchangeItemsFromActionsStep - Medusa Core Workflows Reference

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

This step creates exchange items from change actions.

Note: You can retrieve an order change action details using Query, or useQueryGraphStep.

Example#

Code
1const data = createOrderExchangeItemsFromActionsStep({2  exchangeId: "exchange_123",3  changes: [4    {5      id: "orchact_123",6      // other order change action details...7    }8  ]9})

Input#

CreateOrderExchangeItemsFromActionsInputCreateOrderExchangeItemsFromActionsInput

The details of creating exchange items from change actions.

changesOrderChangeActionDTO[]

The change actions to create exchange items from.

exchangeIdstring

The ID of the exchange to create the items for.

Output#

OrderExchangeItemDTO[]OrderExchangeItemDTO[]

idstring

The ID of the order exchange item.

exchange_idstring

The associated exchange's ID.

order_idstring

The associated order's ID.

item_idstring

The associated item's ID.

itemOrderLineItemDTO

The associated item.

quantitynumber

The quantity of the order exchange item

raw_quantityBigNumberRawValue

The raw quantity of the order exchange item

metadatanull | Record<string, unknown>Optional

Holds custom data in key-value pairs.

created_atstring | DateOptional

The creation date of the order exchange item

updated_atstring | DateOptional

The update date of the order exchange item

Was this page helpful?