updatePromotionsStatusWorkflow - Medusa Core Workflows Reference

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

This workflow updates the status of one or more promotions.

This workflow has a hook that allows you to perform custom actions on the updated promotions. For example, you can pass under additional_data custom data that allows you to create custom data models linked to the promotions.

You can also use this workflow within your customizations or your own custom workflows, allowing you to update the status of promotions within your custom flows.

Examples#

Steps#

Input#

Output#

Hooks#

Hooks allow you to inject custom functionalities into the workflow. You'll receive data from the workflow, as well as additional data sent through an HTTP request.

Learn more about Hooks and Additional Data.

promotionStatusUpdated#

This hook is executed after the promotions' status is updated. You can consume this hook to perform custom actions on the updated promotions.

Example

Code
1import { updatePromotionsStatusWorkflow } from "@medusajs/medusa/core-flows"2
3updatePromotionsStatusWorkflow.hooks.promotionStatusUpdated(4  (async ({ promotions, additional_data }, { container }) => {5    //TODO6  })7)

Input

Handlers consuming this hook accept the following input.