Announcement: You can find the guides for Commerce 7.5 and later on the new Elastic Path Documentation site. This Developer Center contains the guides for Commerce 6.13.0 through 7.4.1.Visit new site

This version of Elastic Path Commerce is no longer supported or maintained. To upgrade to the latest version, contact your Elastic Path representative.

Tagging Framework

Tagging Framework

The Tagging Framework allows you to track information about objects in Elastic Path Commerce. You can then build conditions to evaluate that information and make decisions about application behavior. There are many potential uses for the Tagging Framework. Currently, it's used to store information about shoppers. The shopper's tag set is evaluated against Price List Assignment conditions to determine which Price Lists to apply.

For example, when a shopper arrives at the storefront, the referrer URL is stored in a tag in the shopper's tag set. Before displaying a page, the shopper's tag set is evaluated against all Dynamic Content Delivery conditions to determine if there is Dynamic Content to display. One piece of Dynamic Content has a Delivery condition that requires the referrer URL to be a page on an affiliate site. The shopper's referrer URL tag contains the expected page's URL, so the Dynamic Content, a special promotion for affiliate customers, is displayed.


If you want to create custom tags, you need to set them up in the database. Next, you need to create tag event listeners to capture the tag values and add the tags to an object's tag sets. Then you need to create conditions. If your application users will be building conditions, you can use the condition builder widget. Finally, you will need to evaluate those conditions. The Tagging Framework includes APIs for working with tags and evaluating conditional expressions.