prepareAdjustmentsFromPromotionActionsStep - Medusa Core Workflows Reference

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

This step prepares the line item or shipping method adjustments using actions computed by the Promotion Module.

Example#

Code
1const data = prepareAdjustmentsFromPromotionActionsStep({2  "actions": [{3    "action": "addItemAdjustment",4    "item_id": "litem_123",5    "amount": 10,6    "code": "10OFF",7  }]8})

Input#

PrepareAdjustmentsFromPromotionActionsStepInputPrepareAdjustmentsFromPromotionActionsStepInput

The details of the actions computed by the Promotion Module.

actionsComputeActions[]

The actions computed by the Promotion Module.

Output#

PrepareAdjustmentsFromPromotionActionsStepOutputPrepareAdjustmentsFromPromotionActionsStepOutput

The details of the adjustments to create and remove.

lineItemAdjustmentsToCreateobject[]

The line item adjustments to create.

lineItemAdjustmentIdsToRemovestring[]

The line item adjustment IDs to remove.

shippingMethodAdjustmentsToCreateobject[]

The shipping method adjustments to create.

shippingMethodAdjustmentIdsToRemovestring[]

The shipping method adjustment IDs to remove.

computedPromotionCodesstring[]

The promotion codes that were computed.