- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
deletePromotionsWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the deletePromotionsWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow deletes one or more promotions. It's used by the Delete Promotions Admin API Route.
You can use this workflow within your own customizations or custom workflows, allowing you to delete promotions within your custom flows.
Source CodeExamples#
Steps#
Input#
DeletePromotionsWorkflowInput
DeletePromotionsWorkflowInputThe data to delete one or more promotions.
DeletePromotionsWorkflowInput
DeletePromotionsWorkflowInputids
string[]The IDs of the promotions to delete.
ids
string[]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.
promotionsDeleted#
This step is a hook that you can inject custom functionality into.
Example
Input
Handlers consuming this hook accept the following input.
input
objectThe input data for the hook.
input
objectids
string[]
ids
string[]Was this page helpful?