shuup.campaigns package

Subpackages

• shuup.campaigns.admin_module package
  • Subpackages
    • shuup.campaigns.admin_module.forms package
      • Module contents
    • shuup.campaigns.admin_module.views package
      • Module contents
  • Submodules
  • shuup.campaigns.admin_module.form_parts module
  • shuup.campaigns.admin_module.form_sets module
  • shuup.campaigns.admin_module.sections module
  • shuup.campaigns.admin_module.utils module
  • Module contents
• shuup.campaigns.api package
  • Submodules
  • shuup.campaigns.api.serializers module
  • Module contents
• shuup.campaigns.management package
  • Subpackages
    • shuup.campaigns.management.commands package
      • Submodules
      • shuup.campaigns.management.commands.rebuild_campaign_caches module
      • Module contents
  • Module contents
• shuup.campaigns.models package
  • Submodules
  • shuup.campaigns.models.basket_conditions module
  • shuup.campaigns.models.basket_effects module
  • shuup.campaigns.models.basket_line_effects module
  • shuup.campaigns.models.cache module
  • shuup.campaigns.models.campaigns module
  • shuup.campaigns.models.catalog_filters module
  • shuup.campaigns.models.contact_group_sales_ranges module
  • shuup.campaigns.models.context_conditions module
  • shuup.campaigns.models.matching module
  • shuup.campaigns.models.product_effects module
  • Module contents
• shuup.campaigns.templates package
  • Module contents
• shuup.campaigns.utils package
  • Submodules
  • shuup.campaigns.utils.campaigns module
  • shuup.campaigns.utils.matcher module
  • shuup.campaigns.utils.sales_range module
  • shuup.campaigns.utils.time_range module
  • Module contents

Submodules

shuup.campaigns.apps module

class shuup.campaigns.apps.CampaignAppConfig(*args, **kwargs)

Bases: shuup.apps.AppConfig

name = 'shuup.campaigns'

verbose_name = 'Shuup Campaigns'

label = 'campaigns'

provides = {'admin_contact_group_form_part': ['shuup.campaigns.admin_module.form_parts:SalesRangesFormPart'], 'discount_module': ['shuup.campaigns.modules:CatalogCampaignModule'], 'order_source_modifier_module': ['shuup.campaigns.modules:BasketCampaignModule'], 'admin_module': ['shuup.campaigns.admin_module:CampaignAdminModule'], 'admin_product_section': ['shuup.campaigns.admin_module.sections:ProductCampaignsSection'], 'campaign_basket_condition': ['shuup.campaigns.admin_module.forms:BasketTotalProductAmountConditionForm', 'shuup.campaigns.admin_module.forms:BasketTotalAmountConditionForm', 'shuup.campaigns.admin_module.forms:BasketTotalUndiscountedProductAmountConditionForm', 'shuup.campaigns.admin_module.forms:BasketMaxTotalProductAmountConditionForm', 'shuup.campaigns.admin_module.forms:BasketMaxTotalAmountConditionForm', 'shuup.campaigns.admin_module.forms:ProductsInBasketConditionForm', 'shuup.campaigns.admin_module.forms:ContactGroupBasketConditionForm', 'shuup.campaigns.admin_module.forms:ContactBasketConditionForm', 'shuup.campaigns.admin_module.forms:CategoryProductsBasketConditionForm', 'shuup.campaigns.admin_module.forms:HourBasketConditionForm', 'shuup.campaigns.admin_module.forms:ChildrenProductConditionForm'], 'campaign_basket_discount_effect_form': ['shuup.campaigns.admin_module.forms:BasketDiscountAmountForm', 'shuup.campaigns.admin_module.forms:BasketDiscountPercentageForm', 'shuup.campaigns.admin_module.forms:DiscountPercentageFromUndiscountedForm'], 'campaign_basket_line_effect_form': ['shuup.campaigns.admin_module.forms:FreeProductLineForm', 'shuup.campaigns.admin_module.forms:DiscountFromProductForm', 'shuup.campaigns.admin_module.forms:DiscountFromCategoryProductsForm'], 'campaign_context_condition': ['shuup.campaigns.admin_module.forms:ContactGroupConditionForm', 'shuup.campaigns.admin_module.forms:ContactConditionForm', 'shuup.campaigns.admin_module.forms:HourConditionForm'], 'campaign_catalog_filter': ['shuup.campaigns.admin_module.forms:ProductTypeFilterForm', 'shuup.campaigns.admin_module.forms:ProductFilterForm', 'shuup.campaigns.admin_module.forms:CategoryFilterForm'], 'campaign_product_discount_effect_form': ['shuup.campaigns.admin_module.forms:ProductDiscountAmountForm', 'shuup.campaigns.admin_module.forms:ProductDiscountPercentageForm'], 'reports': ['shuup.campaigns.reports:CouponsUsageReport']}

ready()

shuup.campaigns.consts module

shuup.campaigns.exceptions module

exception shuup.campaigns.exceptions.CampaignsInvalidInstanceForCacheUpdate

Bases: Exception

shuup.campaigns.modules module

class shuup.campaigns.modules.CatalogCampaignModule

Bases: shuup.core.pricing.DiscountModule

identifier = 'catalog_campaigns'

name = 'Campaigns'

discount_price(context, product, price_info)

Get the discounted price for context.

Best discount is selected. Minimum price will be selected if the cheapest price is under that.

class shuup.campaigns.modules.BasketCampaignModule

Bases: shuup.core.order_creator.OrderSourceModifierModule

identifier = 'basket_campaigns'

name = 'Campaign Basket Discounts'

get_new_lines(order_source, lines)

can_use_code(order_source, code)

use_code(order, code)

clear_codes(order)

shuup.campaigns.reports module

class shuup.campaigns.reports.CouponsUsageForm(*args, **kwargs)

Bases: shuup.default_reports.forms.OrderReportForm

base_fields = OrderedDict([('report', <django.forms.fields.CharField object>), ('writer', <django.forms.fields.ChoiceField object>), ('force_download', <django.forms.fields.BooleanField object>), ('shop', <django.forms.fields.ChoiceField object>), ('date_range', <enumfields.forms.EnumChoiceField object>), ('start_date', <django.forms.fields.DateTimeField object>), ('end_date', <django.forms.fields.DateTimeField object>), ('coupon', <shuup.admin.forms.fields.Select2MultipleField object>)])

declared_fields = OrderedDict([('report', <django.forms.fields.CharField object>), ('writer', <django.forms.fields.ChoiceField object>), ('force_download', <django.forms.fields.BooleanField object>), ('shop', <django.forms.fields.ChoiceField object>), ('date_range', <enumfields.forms.EnumChoiceField object>), ('start_date', <django.forms.fields.DateTimeField object>), ('end_date', <django.forms.fields.DateTimeField object>), ('coupon', <shuup.admin.forms.fields.Select2MultipleField object>)])

media

class shuup.campaigns.reports.CouponsUsageReport(**kwargs)

Bases: shuup.default_reports.mixins.OrderReportMixin, shuup.reports.report.ShuupReportBase

identifier = 'coupons-usage'

title = 'Coupons Usage'

filename_template = 'coupons-usage-%(time)s'

form_class

alias of CouponsUsageForm

schema = [{'key': 'date', 'title': 'Date'}, {'key': 'coupon', 'title': 'Coupon code'}, {'key': 'order', 'title': 'Order'}, {'key': 'taxful_total', 'title': 'Taxful total'}, {'key': 'taxful_subtotal', 'title': 'Taxful subtotal'}, {'key': 'total_discount', 'title': 'Total discount'}]

get_objects()

get_data(**kwargs)

shuup.campaigns.signal_handlers module

shuup.campaigns.signal_handlers.update_customers_groups(sender, instance, **kwargs)

shuup.campaigns.signal_handlers.invalidate_context_condition_cache(sender, instance, **kwargs)

shuup.campaigns.signal_handlers.update_filter_cache(sender, instance, **kwargs)

shuup.campaigns.signal_handlers.invalidate_context_filter_cache(sender, instance, **kwargs)

Module contents