Skip to content
Log in

Reward Object Reference

On this page

Overview

Reward defines what discount to apply when a Promotion 2 condition is met. Reward records are reusable — the same Reward can be linked to multiple promotions via Promotion 2 Condition records.

Property Value
API Name s_c__Reward__c
Label Reward
Plural Label Rewards
Type Custom Object

Fields

Field Label API Name Type Required Description
Apply First To s_c__Apply_First_To__c Picklist No Which items to discount first when applying to multiple products. most_expensive (default) or least_expensive. Used by discount_on_products and fixed_price_for_n_products types.
Apply To s_c__Apply_To__c Picklist No Which items this reward targets. matched_products (default) — items matched by the condition’s product scopes. specified_products — items matched by this reward’s own product scopes.
Description Use the Name field for an internal label; no separate description field exists on Reward.
Discount Amount s_c__Discount_Amount__c Currency(18,2) No Fixed amount to discount. Used when Discount Type is fixed for discount_on_subtotal, discount_on_products, and discounted_shipping types.
Discount Percentage s_c__Discount_Percentage__c Number(5,2) No Percentage to discount (e.g. 10 for 10% off). Used when Discount Type is percentage.
Discount Points s_c__Discount_Points__c Number No Points equivalent of a fixed discount. Used when Discount Type is fixed and the store operates with a points currency.
Discount Type s_c__Discount_Type__c Picklist No How the discount amount is calculated. percentage (default) or fixed.
Display Name s_c__Display_Name__c Text(255) No Customer-facing label for this reward. Falls back to Identifier if not set.
Exclude Discounted s_c__Exclude_Discounted__c Checkbox No When checked, items that already have a unit discount are excluded from this reward. Default: unchecked.
Exclude Free s_c__Exclude_Free__c Checkbox No When checked, items with a unit price of zero are excluded from this reward. Default: unchecked.
Fixed Amount s_c__Fixed_Amount__c Currency(18,2) No The fixed price to set per product. Used by the fixed_price_for_n_products type.
Fixed Points s_c__Fixed_Points__c Number No Points equivalent of the fixed price. Used by the fixed_price_for_n_products type in stores operating with a points currency.
Frequency s_c__Frequency__c Picklist No How many times this reward can apply per promotion evaluation. once (default) — applies once per evaluation. no_limit — applies without limit, repeating for each qualifying group of items.
Identifier s_c__Identifier__c Text(255) Yes Unique identifier for this reward. Required. Used internally to reference the reward and as a fallback display name.
Max Eligible s_c__Max_Eligible__c Number No Maximum number of cart items this reward applies to. Leave blank for no limit. Items are selected in Apply First To order before the limit is applied.
Quantity s_c__Quantity__c Number No Number of products for free_product and fixed_price_for_n_products types. For free_product, the number of free items to add. For fixed_price_for_n_products, the N in “N products at fixed price”.
Type s_c__Type__c Picklist No The kind of reward. Default: free_product. See reward types below.

Reward types

Value Description
discount_on_subtotal Applies a percentage or fixed discount to the cart subtotal
discount_on_products Applies a percentage or fixed discount to matched or specified products
discounted_shipping Applies a percentage or fixed discount to shipping charges. Set Discount Percentage to 100 for free shipping.
free_product Adds free products to the cart. Set Quantity for the number of free items. Define eligible free products using Promotion 2 Product Scope records with scope type free_product.
fixed_price_for_n_products Sets a fixed price for a quantity of matching products. Set Quantity for N and Fixed Amount for the price.

Field usage by reward type

Field discount_on_subtotal discount_on_products discounted_shipping free_product fixed_price_for_n_products
Discount Type
Discount Percentage
Discount Amount
Quantity
Fixed Amount
Apply To
Apply First To
Max Eligible
Exclude Discounted
Exclude Free

Was this article helpful?

Was this article helpful?