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.
Source CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
object & AdditionalDataobject & AdditionalData
object & AdditionalDataobject & AdditionalDatapromotionsDataobject[]The promotions to update their status.
promotionsDataobject[]AdditionalDataAdditionalData
AdditionalDataAdditionalDataOutput#
PromotionDTO[]PromotionDTO[]
PromotionDTO[]PromotionDTO[]idstringThe ID of the promotion.
idstringcodestringOptionalThe code of the promotion.
codestringOptionalThe type of the promotion:
standard indicates that a promotion is a standard one applied with conditions.buyget indicates that a promotion is a "Buy X get Y" promotion.
standardindicates that a promotion is a standard one applied with conditions.buygetindicates that a promotion is a "Buy X get Y" promotion.
The status of the promotion:
active promotion is available for user to consumeinactive promotion is no longer available to the userdraft promotion is currently being prepared
activepromotion is available for user to consumeinactivepromotion is no longer available to the userdraftpromotion is currently being prepared
is_automaticbooleanOptionalWhether the promotion is applied automatically.
is_automaticbooleanOptionalThe associated application method.
The rules of the promotion.
campaign_idnull | stringOptionalThe associated campaign.
campaign_idnull | stringOptionalThe associated campaign.
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#
Handlers consuming this hook accept the following input.
inputobject
inputobjectpromotionsPromotionDTO[]
promotionsPromotionDTO[]additional_dataRecord<string, unknown> | undefinedAdditional data that can be passed through the additional_data property in HTTP requests.
Learn more in this documentation.
additional_dataRecord<string, unknown> | undefinedadditional_data property in HTTP requests.
Learn more in this documentation.