The page describes the different shopper segment conditions and promotion rules that can be used when configuring promotions.
Shopper Conditions
Shopper conditions can be used to determine who is eligible for a given shopping cart promotion. As of Elastic Path Commerce 8.2 and later, you can apply shopper segment conditions to both Catalog Promotions and Shopping Cart Promotions. Previously they were only available on Shopping Cart Promotions.
Browse Behavior
Browse behavior information is collected as the shopper navigates the storefront.
Tag name
Description
have searched in the store for phrase(string)
The search terms that the shopper enters in the storefront Search field. For the search terms to be recorded, the shopper must actually click the Search button. Note: The search terms are overwritten each time the shopper performs a new search.
have viewed category(string)
The categories that the shopper views in the storefront during the current session. Note:A category is not tracked if the shopper navigates to a product without viewing the parent category.
landed on a store page with URL (string)
The URL that brought the shopper to the storefront. For example: http://snapitup.elasticpath.com:8080/storefront/browse.ep?cID=100009&filters=c90000003&sorter=price-desc
searched on the internet for phrase (string)
The search terms the shoppers enters in the search engine that brought them to the storefront. Currently, this tag is designed to work with the Google, Yahoo, and msn Live search engines. Each search engine uses a different syntax for their searches. When it encounters this tag, Elastic Path Commerce looks for search terms within the originating URL. The tag can extract those search terms from the URLs generated by Google, Yahoo, and msn Live.
were referred from a URL(string)
The URL of the referring site. For example: http://www.google.ca/aclk?sa=l&ai=Cu3BuHnDnSebAJ56wsAPcq-GAC6WN\_nvZ5pr\_A8nYoP4ECAAQAVCyrdOV-\_\_\_\_\_8BYP3A-4DMA6ABp8Cv\_gPIAQGqBBtP0GD2nmBaPAvT5Q8HWz\_UpVlyLbZk9rI0Peg&sig=AGiWqtzbc0FN-Ac8TwPg1073g\_yo6E\_aNg&q=http://www.elasticpath.com
Account Profile
In B2B scenarios, a shopper might be purchasing on behalf of an account (buying organization). In this case, certain shopper conditions can be applied based on account details.
Tag name
Description
are account segment members (string)
The shopper's association to account segments (groups). The information from this tag determines whether or not the promotion should apply based on their inclusion in a particular segment.
have account shared ID (string)
The shopper's shared ID value from the account profile.
Customer Profile
Shoppers who register can optionally provide certain personal information, such as their age. If those shoppers are currently signed in, their profile information is available for use in evaluating the shopper conditions.
Tag name
Description
are customer segment members (string)
The shopper's association to the customer segment. The information from this tag determines whether or not the promotion should apply based on their inclusion in a particular segment.
are first time buyers (boolean)
The shopper's status as a first time buyer.
are of age (years)(integer)
The shopper's age, as computed from their birth date, if stored in their customer profile. The information from this tag is only retained while the shopper is logged in to their customer account in the storefront.
are registered customers (boolean)
The shopper's status as a registered customer. The information from this tag is only retained while the shopper is logged in to their customer account in the storefront.
have customer shared ID (string)
The shopper's shared ID value from the customer profile.
Geo Location
Geo location information is based on the shopper's IP address. It is only available if a third-party Geo IP service is configured. For more information, contact your Elastic Path Commerce server administrator.
Tag name
Description
are browsing from a time zone +/- offset from GMT (string)
The shopper's time zone, relative to GMT (Greenwich Mean Time).
are browsing from an internet connection of type(string)
The type of connection that the shopper is using to access the storefront. Examples of connection types include: Dial up, Cable.
are browsing from an internet IP routing of type (integer)
The IP routing type of a shopper's connection to the storefront. Typical values returned for this could be regional proxy, superproxy, or mobile__gateway. It is useful in determining the shopper's actual location relative to the IP address returned for them.
are browsing from an ISP with second level domain (string)
The second level domain name from the shopper's connection to the storefront. The second level domain name is the portion of the Internet domain name directly above a top level domain name. It is usually the name of the organization that the domain name represents. Examples of second level domains are "google" and "wikipedia".
are browsing from an ISP with top level domain (string)
The top level domain name from the shopper's connection to the storefront. The top level domain name is the portion of the internet domain name following the dot. Examples of a top level domain are ".com", ".ca", ".org".
are browsing from city (string)
The shopper's city.
are browsing from continent (string)
The continent from where the shopper is connected.
are browsing from country code (string)
The two-letter code of the country from where the shopper is connected to the storefront.
are browsing from state or province (string)
The shopper's state or province.
are browsing from zip/postal code (string)
The shopper's zip/postal code.
Conditions
When setting up conditions for a promotion, keep the following points in mind:
"Exactly" – The shopping cart must contain exactly the specified number of items. If the cart contains less or more than the specified number of items, the shopper does not meet the conditions is not eligible for the promotion
"At least" – To meet the conditions and be eligible for the promotion, the shopping cart must contain the specified number of items or more
Catalog Promotions
Value
Description
Category is []
Specifies a category whose products are included in the promotion. You can specify individual products and categories to be excluded from the promotion if required.
Brand is []
Specifies a brand whose products are included in the promotion.
Product is []
Specifies a product to include in the promotion.
Product SKU is []
Specifies a product SKU to include in the promotion.
Product attribute [] has value []
Specifies that any products with an attribute matching the specified value should be included in the promotion.
Product SKU attribute [] has value []
Specifies that any product SKUs with an attribute matching the specified value should be included in the promotion.
Shopping Cart Promotions - Cart Level Rules
Value
Description
[] [] items are in the shopping cart
Specifies the number of items that must be in the shopping cart. . You can specify individual products, categories, or SKUs to be ignored when calculating the number of cart items. For example, in a promotion that gives a shopper a free camera bag when 3 or more items are purchased, you could set an exclusion condition to not include items from the "Camera Bags" categories when calculating the number of cart items.
[] [] items of Category [] are in the shopping cart
Specifies how many items from a particular category must be in the shopping cart. . You can specify individual products, categories, or SKUs to be ignored when calculating the number of cart items.
[] [] items of Product [] are in the shopping cart
Specifies the number of items of a particular product that must be in the shopping cart. . You can specify individual SKUs to be ignored when calculating the number of cart items.
[] [] items of Product with attribute [] having value [] are in the shopping cart
Specifies the number of items of any product with an attribute matching the specified value that must be in the shopping cart.
[] [] items of SKU [] are in the shopping cart
Specifies the number of items of a particular SKU that must be in the shopping cart.
[] [] items of Product SKU with attribute [] having value [] are in the shopping cart
Specifies the number of items of any product SKU with an attribute matching the specified value that must be in the shopping cart.
Cart subtotal is at least $[]
Specifies a minimum total value that must be in the shopping cart. . You can specify individual products, categories, or SKUs to be ignored when calculating the subtotal.
Currency is []
Specifies the currency of the shopping cart.
Shopping Cart Promotions - Line Item Level Rules
Value
Description
Currency is []
Specifies the currency of the shopping cart.
Line item product SKU is []
Specifies that the cart line item is for a particular product SKU.
Line item product SKU attribute [] has value []
Specifies that the cart line item product SKU has an attribute matching the specified value.
Line item product is []
Specifies that the cart line item is for a particular product.
Line item product attribute [] has value []
Specifies that the cart line item product has an attribute matching the specified value.
Line item product is from category []
Specifies that the cart line item product is contained within the specified category.
Line item quantity is [] []
Specifies that the cart line item quantity is at least, at most, or exactly matching the specified value.
Line item subtotal is [] $[]
Specifies that the cart line item subtotal is at least, at most, or exactly matching the specified value.
Actions
When evaluating actions, the system considers items found in the cart in the order in which they are added. For example, if the condition states that a 100% discount will be applied to an item in the cart when the shopper adds "exactly" 3 items of Category B to the cart, the 100% discount would apply to the third item added.
Catalog Promotions
Catalog Discount
Value
Description
Get []% off when currency is []
Applies a percentage discount for items in the specified currency.
Get []$ off when currency is []
Applies a fixed currency value discount for items in the specified currency.
Shopping Cart Promotions - Cart Level Rules
Cart Item Discount
Value
Description
Get []% off [] items
Applies a percentage discount to the specified number of items added to the shopping cart. . You can specify individual products, categories, or SKUs to be excluded from the promotion.
Get $[] off [] items
Applies a fixed currency discount to the specified number of items added to the shopping cart. You can specify individual products, categories, or SKUs to be excluded from the promotion.
Get []% off [] items in category []
Applies a percentage discount to the specified number of items added to the shopping cart from the specified category. You can specify individual products, categories, or SKUs to be excluded from the promotion.
Get $[] off [] items in category []
Applies a fixed currency value discount to the specified number of items added to the shopping cart from the specified category. . You can specify individual products, categories, or SKUs to be excluded from the promotion.
Get []% off [] items of product []
Applies a percentage discount to the specified number of items with the specified product code added to the shopping cart. You can specify individual SKUs to be excluded from the promotion.
Get $[] off [] items of product []
Applies a fixed currency value discount to the specified number of items with the specified product code added to the shopping cart. You can specify individual SKUs to be excluded from the promotion.
Get []% off [] items of SKU []
Applies a percentage discount to the specified number of items with the specified SKU added to the shopping cart.
Get $[] off [] items of SKU []
Applies a fixed currency value discount to the specified number of items with the specified SKU added to the shopping cart.
Get [] free items of SKU []
The shopper receives the specified number of items with the specified SKU number for free. If the cart contents change, and the promotion conditions no longer apply, the SKU will be automatically removed from the shopping cart.
Get []% off item number [] of product []
The shopper receives a percentage discount on the specified product if a minimum number of those are added to the cart. You can specify individual SKUs to be excluded from the promotion. Note: This discount is only applied to a single item of that product in the cart. If that minimum number is reached multiple times, the discount is applied on the last occurrence. For example, the promotion has the action Get 100% off item number 3 of product TSHIRT. If a shopper adds 3 TSHIRT products with SKU M and 3 TSHIRT products with SKU XXL, the discount is only applied to the third TSHIRT product with SKU XXL.
Cart Subtotal Discount
Value
Description
Get []% off cart subtotal
Applies a percentage discount amount off on the sub total value of the shopping cart. The subtotal value is the amount of the cart prior to shipping and taxes.
Get $[] off cart subtotal
Applies a fixed currency value discount to the sub total value of the shopping cart. The subtotal value is the amount of the cart before shipping and taxes.
Shipping Discount
Value
Description
Get []% off shipping service level []
Applies a percentage discount to only the shipping portion of the shopping cart total. The discounts apply to the shipping levels defined for the storefront.
Get $[] off shipping service level []
Applies a fixed currency value discount to only the shipping portion of the shopping cart total. The discounts apply to the shipping levels defined for the storefront.
Coupon
Value
Description
Eligibility for promotion []
Grants a coupon that the customer can apply to a future purchase. Note: The coupon code cannot be applied to the current order.) Each time a customer qualifies for the promotion, they are assigned a unique, automatically generated coupon code. The list contains all of the store's shopping cart promotions that are activated by private coupons. You must specify a coupon code prefix, which is added to each generated coupon code. The prefix may contain a maximum of 16 alphanumeric characters.
Shopping Cart Promotions - Line Item Level Rules
Line Item Discount
Value
Description
Get []% off line item subtotal
Applies a percentage discount to the cart line item.
Get $[] off line item subtotal
Applies a fixed currency discount to the cart line item.
Get $[] off line item subtotal for each multiple of []
Applies a fixed currency discount to the cart line item for each multiple of a specific quantity. For example, if the multiple is set to 2, then the discount is added for every multiple of 2 that is specified in the quantity.
Get [] free
Applies a discount equal to the unit subtotal of the cart line item times the specified quantity.
Get [] free for each multiple of []
Applies a discount equal to the unit subtotal of the cart line item times the specified quantity for each multiple of a specific quantity.
. You can specify individual products, categories, or SKUs to be ignored when calculating the number of cart items. For example, in a promotion that gives a shopper a free camera bag when 3 or more items are purchased, you could set an exclusion condition to not include items from the "Camera Bags" categories when calculating the number of cart items.
. You can specify individual products, categories, or SKUs to be ignored when calculating the number of cart items.
. You can specify individual SKUs to be ignored when calculating the number of cart items.
. You can specify individual products, categories, or SKUs to be ignored when calculating the subtotal.
. You can specify individual products, categories, or SKUs to be excluded from the promotion.
. You can specify individual products, categories, or SKUs to be excluded from the promotion.
The list contains all of the store's shopping cart promotions that are activated by private coupons. You must specify a coupon code prefix, which is added to each generated coupon code. The prefix may contain a maximum of 16 alphanumeric characters.