Discounts in Shuup

Shuup provides two ways to give discounts for products. First way DiscountModule and second being the OrderSourceModifierModule. Both of these function very differently and are explained in this document.

Unlike the PricingModule, there can be multiple modules which provide discounts to the product at any given time.

DiscountModule

This module can give discounts based on the given context for a given product. There is one implementation using the DiscountModule currently in shuup: CatalogCampaignModule.

OrderSourceModifierModule

This module directly modifies the given OrderSource.

There is currently one implementation using the OrderSourceModifierModule Shuup: BasketCampaignModule.

Campaigns

The Shuup base installation comes with Catalog Campaign and Basket Campaign which are polymorphic models.

To determine if a campaign should be applied, Shuup looks for the filters and conditions for the campaign. If a matching campaign is found, an effect will be applied.

Catalog Campaign

A CatalogCampaignModule directly applies discounts to products when browsing the catalog. If a catalog campaign matches, it usually matches everywhere in the shop, basket and catalog.

To determine if a catalog campaign matches, Shuup looks for filters and conditions

Catalog Filters

CatalogFilter can filter product querysets and matches directly to product properties.

Context Conditions

ContextCondition matches based on context. This is handy if you need to give a discount for a certain customer group or something that is available in context.

Product Discount Effects

ProductDiscountEffect gives the discount for product. This modifiers the products PriceInfo directly by setting the price.

Basket Campaign

A campaign that affects only the products in basket. Shuup checks basket conditions to see if a basket campaign should be applied. Basket campaigns can also require a coupon to activate.

Basket Conditions

BasketCondition matches the basket contents to activate. For example, basket campaigns can use basket conditions to check the number of products in the customer basket to determine if the campaign should apply.

Basket Discount Effects

BasketDiscountEffect matches the basket contents to activate. This effect returns a discount amount value that can be used to create a new line for example.

Basket Line Effects

BasketLineEffect matches the basket contents to activate. This effect adds a new line to the order source which can be used to give a free product