This documentation provides a reference to the createPromotionsWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow creates one or more promotions. It's used by the Create Promotion Admin API Route.
This workflow has a hook that allows you to perform custom actions on the created promotion. 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 wrap custom logic around creating promotions.
Source CodeCreatePromotionsWorkflowInput
CreatePromotionsWorkflowInputpromotionsData
CreatePromotionDTO[]additional_data
Record<string, unknown>Optionaladditional_data
property in HTTP requests.
Learn more in this documentation.PromotionDTO[]
PromotionDTO[]id
stringcode
stringOptionalstandard
indicates that a promotion is a standard one applied with conditions.buyget
indicates that a promotion is a "Buy X get Y" promotion.active
promotion is available for user to consumeinactive
promotion is no longer available to the userdraft
promotion is currently being preparedis_automatic
booleanOptionalcampaign_id
null | stringOptionalHooks 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.
This hook is executed after the promotions are created. You can consume this hook to perform custom actions on the created promotions.
Handlers consuming this hook accept the following input.
input
inputpromotions
PromotionDTO[]additional_data
Record<string, unknown> | undefinedadditional_data
property in HTTP requests.
Learn more in this documentation.