Manages ecommerce pricing rules: tiered pricing, promotional discounts, checkout rules and per-store shipping and tax configuration for a store's products. Rules are loaded from CSV and XML settings files stored under WEB-INF in the website's live branch, and applyRules combines the best-matching tier and promotional rules to work out a purchaser's adjusted price for a product. Registered with the ecommerce app as the "pricingRulesService" service and used directly by PriceManager and CartManager when pricing a sale.

Group: Managers

---

Properties

---

Methods

getRules() · rules(ECommerceStore store) · rules(ECommerceStore store, WebsiteRootFolder wrf) · saveRules(String storeName, List<PricingRule> list, Website website, Profile curUser) · savePricingConfig(String storeName, PricingConfiguration config, Website website, Profile currentUser) · saveCheckoutRules(String storeName, CheckoutRules checkoutRules, Website website, Profile currentUser) · parseRules(String text) · applyRules(BaseEntity purchaser, BaseEntity vendor, ECommerceStore store, Product product, ProductSku sku, BigDecimal listPrice, BigDecimal quantity, BigDecimal totalSale, Map<String,String> customFieldsMap, Set<Reward> activatedPromos, List<String> rulesNarrative) · findMatching(PricingRulesSet ruleSet, Set<Reward> activatedPromos, Product product, ProductSku sku, BaseEntity purchaser, BigDecimal quantity, BigDecimal totalSale, BaseEntity vendor, Map<String,String> customFieldsMap, Organisation adminOrg) · applyRule(PricingRule rule, BigDecimal listPrice, BaseEntity purchaser, Product product, BigDecimal quantity) · calcTax(BigDecimal finalPriceExTax, ProductInEComStore productInStoreList, ISale sale) · taxRate(BigDecimal adjustedPriceExTax, ProductInEComStore productInStore, ISale sale)

getRules()

Returns: PricingRulesSet

Deprecated, use rules(store) instead. Looks up the current website from the request context and returns its pricing rules, or null if the current root folder is not a website or has no ecommerce store.

rules(ECommerceStore store)

Returns: PricingRulesSet

Returns the pricing rules configured for the given ecommerce store, combining tiered pricing, promotional availability, checkout rules and shipping/tax provider settings. Returns null rather than an empty rule set when the store is null or its website root folder cannot be resolved.

rules(ECommerceStore store, WebsiteRootFolder wrf)

Returns: PricingRulesSet

Returns the pricing rules configured for the given store, looking them up from the website settings attached to the supplied root folder. Never returns null: falls back to an empty pricing rules set when the store has no saved settings.

saveRules(String storeName, List<PricingRule> list, Website website, Profile curUser)

Returns: void

Serialises the given pricing rules to CSV and writes them to the store's pricing rules file under WEB-INF in the website's live branch, creating the file if it does not already exist.

savePricingConfig(String storeName, PricingConfiguration config, Website website, Profile currentUser)

Returns: void

Serialises the given pricing configuration (shipping and tax provider settings) to XML and writes it to the store's settings file under WEB-INF in the website's live branch, creating the file if it does not already exist.

saveCheckoutRules(String storeName, CheckoutRules checkoutRules, Website website, Profile currentUser)

Returns: void

Serialises the given checkout rules to XML and writes them to the store's checkout rules file under WEB-INF in the website's live branch, creating the file if it does not already exist.

parseRules(String text)

Returns: List<PricingRule>

Parses pricing rules from CSV text, one PricingRule per non-blank row. Column order follows the format written by the matching save/export logic: promotion name, user id, group name, org id, org type, min/max quantity, category, brand, base product code, mvel expression, add/mult/fixed value, notes, min/max total sale, custom fields and vendor org type.

applyRules(BaseEntity purchaser, BaseEntity vendor, ECommerceStore store, Product product, ProductSku sku, BigDecimal listPrice, BigDecimal quantity, BigDecimal totalSale, Map<String,String> customFieldsMap, Set<Reward> activatedPromos, List<String> rulesNarrative)

Returns: AdjustedPrices

Works out the adjusted price for a product by finding the best-matching tier and promotional pricing rules for the store and applying them in turn: a tier rule is applied to the ex-tax unit price and multiplied by quantity, then a promotional rule (if any) is applied to the resulting inc-tax cost to give the final promotional cost. Human-readable descriptions of each step applied are appended to rulesNarrative.

findMatching(PricingRulesSet ruleSet, Set<Reward> activatedPromos, Product product, ProductSku sku, BaseEntity purchaser, BigDecimal quantity, BigDecimal totalSale, BaseEntity vendor, Map<String,String> customFieldsMap, Organisation adminOrg)

Returns: Set<PricingRule>

Finds the pricing rules in the given rule set whose match criteria (product, sku, quantity, org, group, custom fields and activated promotions) are satisfied for the given purchaser and product. Used by applyRules to narrow the store's rule set down to the rules that actually apply to the current sale.

applyRule(PricingRule rule, BigDecimal listPrice, BaseEntity purchaser, Product product, BigDecimal quantity)

Returns: BigDecimal

Applies a single pricing rule to a list price: a fixed value replaces the price, an add value is added, a multiplier is applied, and finally, if the rule has an mvel expression, that expression is evaluated (with the purchaser, product, adjusted price and quantity in scope) and its result becomes the final price.

calcTax(BigDecimal finalPriceExTax, ProductInEComStore productInStoreList, ISale sale)

Returns: BigDecimal

Calculates the tax amount for a price by multiplying it by the effective tax rate for the product in its store, as returned by taxRate.

taxRate(BigDecimal adjustedPriceExTax, ProductInEComStore productInStore, ISale sale)

Returns: BigDecimal

Works out the tax rate to apply to a product in a store. Tries each configured tax calc provider for the store in turn and uses the first non-null rate returned, falling back to the product's effective GST rate (or zero) if no provider applies.