Loading...
Was this page helpful?
Loading...
createPromotionsStep - Medusa Core Workflows Reference
This documentation provides a reference to the createPromotionsStep. It belongs to the @medusajs/medusa/core-flows package.
This step creates one or more promotions.
Example#
Input#
CreatePromotionDTO[]CreatePromotionDTO[]
CreatePromotionDTO[]CreatePromotionDTO[]codestringThe code of the promotion.
codestringThe 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.
statusPromotionStatusValuesThe status of the promotion:
draft indicates that a promotion is currently being preparedactive indicates that a promotion is activeinactive indicates that a promotion is no longer active
statusPromotionStatusValuesdraftindicates that a promotion is currently being preparedactiveindicates that a promotion is activeinactiveindicates that a promotion is no longer active
application_methodCreateApplicationMethodDTOThe associated application method.
application_methodCreateApplicationMethodDTOis_automaticbooleanOptionalWhether the promotion is applied automatically.
is_automaticbooleanOptionalis_tax_inclusivebooleanOptionalWhether the promotion is tax inclusive.
is_tax_inclusivebooleanOptionalThe rules of the promotion.
The associated campaign.
campaign_idstringOptionalThe associated campaign's ID.
campaign_idstringOptionalOutput#
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_automaticbooleanOptionalis_tax_inclusivebooleanOptionalWhether the promotion is tax inclusive.
is_tax_inclusivebooleanOptionalThe associated application method.
The rules of the promotion.
campaign_idnull | stringOptionalThe associated campaign.
campaign_idnull | stringOptional