updatePromotionsStep - Medusa Core Workflows Reference

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

This step updates one or more promotions.

Example#

Code
1const data = updatePromotionsStep([2  {3    id: "promo_123",4    code: "10OFF"5  }6])

UpdatePromotionDTO[]UpdatePromotionDTO[]

idstring

The ID of the promotion.

is_automaticbooleanOptional

Whether the promotion is applied automatically.

codestringOptional

The code of the promotion.

The type of the promotion.

is_tax_inclusivebooleanOptional

Whether the promotion is tax inclusive.

The status of the promotion:

application_methodOmit<UpdateApplicationMethodDTO, "id">Optional

The associated application method.

campaign_idnull | stringOptional

The associated campaign's ID.

PromotionDTO[]PromotionDTO[]

idstring

The ID of the promotion.

codestringOptional

The code of the promotion.

The 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.

The status of the promotion:

is_automaticbooleanOptional

Whether the promotion is applied automatically.

is_tax_inclusivebooleanOptional

Whether the promotion is tax inclusive.

application_methodApplicationMethodDTOOptional

The associated application method.

rulesPromotionRuleDTO[]Optional

The rules of the promotion.

campaign_idnull | stringOptional

The associated campaign.

campaignCampaignDTOOptional

The associated campaign.