Sale Promotion Rule (sale_promotion_rule)

This module adds the concept of promotion rules that can be applied on
the sale order.

Two kinds of rules are implemented:  
- automatic
- coupon

Automatic rules are applied/recomputed automatically for a sale order
when the user clicks on the button "Apply discount" in the view form.
Depending on the rule's criteria more than one automatic rule can be
applied to a same sale order.

Coupon are special manual rules. Only one coupon can be applied to a
sale order. This rule takes always precedence over automatic rules.

![Promotion rules screenshot](../sale_promotion_rule/static/description/promotion_rule.png)

Code Analysis ⓘ

Views touched (5)

XML ID	Name	Model	Type	Status
`sale_order_add_coupon_form_view`	sale.order.add.coupon.form (in sale_promotion_rule)	sale.order.add.coupon	form	New
`view_order_form`		sale.order	form	Inherits sale.view_order_form
`view_sale_order_applied_sale_promotion_rule_tree`		sale.promotion.rule	tree	New
`view_sale_promotion_rule_form`		sale.promotion.rule	form	New
`view_sale_promotion_rule_tree`		sale.promotion.rule	tree	New

HTTP endpoints (0)

No HTTP endpoints found for this module.

Models touched (4)

New fields (5)

applied_promotion_rule_ids Many2many → sale.promotion.rule
compute='_compute_applied_promotion_rule_ids' string='Applied Promotion rules' args: 'sale.promotion.rule'
coupon_code Char
readonly=True related='coupon_promotion_rule_id.code' store=True string='Coupont Promotion Code'
coupon_promotion_rule_id Many2one → sale.promotion.rule
domain=[('rule_type', '=', 'coupon')] index=True readonly=True string='Coupon promotion rule' args: 'sale.promotion.rule'
has_promotion_rules Boolean
compute='_compute_has_promotion_rules'
promotion_rule_ids Many2many → sale.promotion.rule
domain=[('rule_type', '!=', 'coupon')] index=True readonly=True string='Promotion rules' args: 'sale.promotion.rule'

Public methods (3)

add_coupon(self, coupon_code)
apply_promotions(self)
clear_promotions(self)

New fields (1)

name Char
required=True string='Coupon Name'

Public methods (1)

doit(self)

New fields (6)

applied_promotion_rule_ids Many2many → sale.promotion.rule
compute='_compute_applied_promotion_rule_ids' string='Applied Promotion rules' args: 'sale.promotion.rule'
coupon_code Char
readonly=True related='coupon_promotion_rule_id.code' store=True
coupon_promotion_rule_id Many2one → sale.promotion.rule
domain=[('rule_type', '=', 'coupon')] string='Coupon promotion rule' args: 'sale.promotion.rule'
has_promotion_rules Boolean
compute='_compute_has_promotion_rules'
is_promotion_line Boolean
help='True if the line has been added by a promotion rule'
promotion_rule_ids Many2many → sale.promotion.rule
domain=[('rule_type', '!=', 'coupon')] string='Promotion rules' args: 'sale.promotion.rule'

Public methods (0)

No public methods.

New fields (19)

code Char
company_id Many2one → res.company
comodel_name='res.company' help='Define on which company this promotion rule is available (let it empty if available for every companies)' index=True string='Company'
date_from Date
date_to Date
discount_amount Float
digits='Discount' required=True
discount_amount_currency_id Many2one → res.currency
default=<expr> string='Discount Amount Currency' args: 'res.currency'
discount_product_id Many2one → product.product
domain=[('type', '=', 'service')] string='Product used to apply the promotion' args: 'product.product'
discount_type Selection
default='percentage' required=True selection=[('percentage', 'Percentage'), ('amount_tax_included', 'Amount (Taxes included)'), ('amount_tax_excluded', 'Amount (Taxes excluded)')]
is_minimal_amount_tax_incl Boolean
default=True required=True args: 'Tax included into minimal amount?'
minimal_amount Float
digits='Discount'
multi_rule_strategy Selection
default='use_best' selection=[('use_best', 'Use the best promotion'), ('cumulate', 'Cumulate promotion'), ('exclusive', 'Exclusive promotion'), ('keep_existing', 'Keep existing discount')]
name Char
required=True translate=True
only_newsletter Boolean
promo_type Selection
default='discount' required=True selection=[('discount', 'Discount')]
restrict_partner_ids Many2many → res.partner
column1='rule_id' column2='partner_id' comodel_name='res.partner' relation='discount_rule_partner_rel' string='Restricted partners'
restrict_pricelist_ids Many2many → product.pricelist
column1='rule_id' column2='pricelist_id' comodel_name='product.pricelist' relation='discount_rule_pricelist_rel' string='Restricted pricelists'
rule_type Selection
default='coupon' required=True selection=[('coupon', 'Coupon'), ('auto', 'Automatic')]
sequence Integer
default=10
usage_restriction Selection
default='no_restriction' required=True selection=[('one_per_partner', 'One per partner'), ('no_restriction', 'No restriction')]

Public methods (5)

apply_auto(self, orders)
@api.model

Apply automatic promotion rules to the orders
apply_coupon(self, orders, coupon_code)
Add a coupon to orders
compute_promotions(self, orders)
@api.model

Compute available promotions on the given orders. If a coupon is already defined on the orders, it's preserved
name_get(self)
remove_promotions(self, orders)
@api.model

Loading…

Code Analysis ⓘ

Views touched (5)

HTTP endpoints (0)

Models touched (4)

sale.order Extends Model 5 fields 3 methods SaleOrder · inherits sale.order

sale.order.add.coupon New model TransientModel 1 field 1 method SaleOrderAddCoupon · Sale Order Add Coupon

sale.order.line Extends Model 6 fields 0 methods SaleOrderLine · inherits sale.order.line