--- schema_version: "1" id: 602f6dff28b8cb71521a27ba020d7b7c098da65c53f39a6cdf07368643df6295 title: Point of Sale Loyalty Overview collection: admin version: current locale: en-us portal_url: https://docs.salesforce.com/admin/current/en-us/commerce/264-0-0/rt_pos_clienteling_loyalty_overview.md canonical_url: https://help.salesforce.com/s/articleView?id=commerce.rt_pos_clienteling_loyalty_overview.htm&release=264.0.0&type=5 source_site: help.salesforce.com content_type: documentation content_hash: 1f37e645f482dcb2d3a696c96395d7a1190f086bdee66c517241c6f426044ec1 description: Point of Sale supports loyalty integration. This integration facilitates the search for loyalty customers within the app, and shows and applies available rewards to the cart. products: - Commerce release: "264" --- # Point of Sale Loyalty Overview Point of Sale supports loyalty integration. This integration facilitates the search for loyalty customers within the app, and shows and applies available rewards to the cart. ## Prerequisites - Modern POS App Build: 9.7.1 or greater - Platform Support: iPhone & iPad - Offline Support: no Technical Requirements: configure [Point of Sale's Loyalty SPIs](https://help.salesforce.com/s/articleView?id=commerce.rt_pos_clienteling_loyalty_spis.htm&release=264.0.0&type=5 "Use Point of Sale's SPI to connect your loyalty program to the POS app. Make it easier to find loyalty customers and show rewards.") ## Adding a Loyalty Field during Customer Creation or Editing Begin the loyalty journey by including a loyalty ID lookup field during customer creation or editing in Point of Sale. Detailed instructions can be found in [New Customer Signup](https://help.salesforce.com/s/articleView?id=commerce.rt_cms_layouts_templates_sign_up.htm&release=264.0.0&type=5 "Point of Sale enables businesses to boost customer engagement and loyalty by setting up a new customer sign-up layout. Customers can easily create accounts, subscribe to newsletters, and join rewards programs, enhancing their overall experience and driving long-term retention.").![The Textfield window in Point of Sale CMS where you can add a Loyalty ID.](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-commerce-retail-264-0-0-production-enus/17d647fb-8988-49fb-9add-c4f4cc79c9e4/retail/images/rt_pos_clienteling_new_customer_signup_window.png) ### Enriching Customer 360 Profile The Customer 360 profile can be enhanced to show information obtained from Point of Sale's SPI. These PS Tags are available to show loyalty information: | Account Information | PS Tag | Description | | --- | --- | --- | |   | :ps\_account\_number | ID associated with the customer's loyalty program profile | | Loyalty Points & Credits | PS Tag | Description | | --- | --- | --- | |   | :ps\_total\_points | Total number of loyalty points the customer has earned | |   | :ps\_current\_reward\_points | Current balance of reward points available for redemption | |   | :ps\_total\_store\_credit | Total store credit available in the customer's loyalty profile | |   | :ps\_current\_credits | Current credit balance in the customer's loyalty profile | |   | :ps\_points\_to\_next\_reward | Number of points needed to redeem the next reward | | Current Loyalty Tier | PS Tag | Description | | --- | --- | --- | |   | :ps\_current\_loyalty\_tier\_name | Name of the current loyalty tier the customer belongs to | |   | :ps\_current\_loyalty\_tier\_title | Title associated with the customer's current loyalty tier | |   | :ps\_current\_loyalty\_tier\_subtitle | Subtitle describing the customer's current loyalty tier | |   | :ps\_current\_tier\_date | Date that the customer reached their current loyalty tier | |   | :ps\_current\_tier\_expiry\_date | Expiry date of the customer's current loyalty tier | |   | :ps\_current\_loyalty\_tier\_display | Display name of the customer's current loyalty tier | | Next Loyalty Tier | PS Tag | Description | | --- | --- | --- | |   | :ps\_next\_loyalty\_tier\_display | Display name of the next loyalty tier the customer can achieve | |   | :ps\_next\_loyalty\_tier\_name | Name of the next loyalty tier | |   | :ps\_next\_loyalty\_tier\_title | Title of the next loyalty tier the customer can achieve | |   | :ps\_points\_to\_next\_tier | Number of points needed to reach the next loyalty tier | | Rewards Information | PS Tag | Description | | --- | --- | --- | |   | :ps\_num\_rewards | Number of unique rewards currently available for redemption | |   | :ps\_num\_cash\_rewards | Number of cash rewards available to the customer | |   | :ps\_num\_rewards\_total | Total dollar value of rewards | |   | :ps\_num\_rewards\_total\_2 | An alternative, total dollar value of rewards, — including or excluding specific reward types | |   | :ps\_num\_rewards\_total\_2\_no\_dec | Total value of available rewards (no decimal) | |   | :ps\_num\_cash\_rewards\_total\_no\_dec | Total value of the cash rewards the user has (no decimal) | ### Enriching Print & Email Receipts Like the Customer 360 profile, printed and electronic receipts can also be improved to show loyalty information of a customer using PS Tags. The tags in the table are available for use, but that they're only functional in app builds 9.8.1 or later For more tags related to loyalty, refer to [Print Tags Comprehensive List](https://help.salesforce.com/s/articleView?id=commerce.rt_cms_layouts_receipts_tags_list.htm&release=264.0.0&type=5 "Show dynamic data in your layouts by using Point of Sale print tags as placeholders. Each tag includes its description, location, receipt components, group list, and data mapping. Grouped lists output multiple data points for each tag.") and [Email Tags Comprehensive List](https://help.salesforce.com/s/articleView?id=commerce.rt_cms_layouts_receipts_tags_config_email.htm&release=264.0.0&type=5 "Email tags in Point of Sale are placeholders for email and print templates that pull specific information from data that are then shown instead of the actual placeholder."). | Print Tags | Email Tags | Description | | --- | --- | --- | | :ps\_loyalty\_reward\_value | {reward\_amount} | Displays the amount of loyalty transaction discount rewards redeemed in the transaction (for example $5.00). Coupon rewards won't be listed as they are inherently applied as promotions and are shown on the receipt in the standard promotion format. | | :ps\_loyalty\_reward\_code | {reward\_code} | Displays the loyalty transaction discount reward codes redeemed in the transaction (for example 1234). Coupon rewards won't be listed as they are inherently applied as promotions and will be shown on the receipt in the standard promotion format. | | :ps\_loyalty\_reward\_name | {reward\_name} | Displays the name of the loyalty transaction discount rewards redeemed in the transaction (for example 5Dollar Reward). Coupon rewards won't be listed as they are inherently applied as promotions and are shown on the receipt in the standard promotion format. | | :ps\_points\_earned | {loyalty\_points\_earned} | Displays the total quantity of loyalty points redeemed in the transaction. As Retail Cloud doesn't calculate points, this data is retrieved from Point of Sale's Loyalty SPI if configured accordingly. | Example print configuration: ![A print receipt configration example in Point of Sale CMS.](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-commerce-retail-264-0-0-production-enus/17d647fb-8988-49fb-9add-c4f4cc79c9e4/retail/images/rt_pos_clienteling_loyalty_print_config.png) Example print receipt: ![An exampe of a printed receipt with the loyalty points recorded.](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-commerce-retail-264-0-0-production-enus/17d647fb-8988-49fb-9add-c4f4cc79c9e4/retail/images/rt_pos_clienteling_loyalty_printed_receipt.png) ### Adding Loyalty Visual Badge The Loyalty visual badge image is retrieved through the attribute "logoUrl" within the Get Customer API, where a URL is passed to us as a string (shown as a gold star). The image specifications are 20x20 pixels in size with a recommended file size of 5 KB. If a URL is included in this field for a customer, the badge automatically appears in both the search and header sections of the app for that specific customer. To add it to the Customer 360 experience, you can set it up using the layout editor. This is under **Loyalty > Loyalty Badge Image**. ![The loyalty visual badge in the CMS.](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-commerce-retail-264-0-0-production-enus/17d647fb-8988-49fb-9add-c4f4cc79c9e4/retail/images/rt_pos_clienteling_loyalty_badge.png) ### Loyalty Sign-up and Enrollment For app builds 9.8.1 or greater, customers can sign up for a merchant's loyalty program on the POS app. Created customers can also be enrolled if editing their profile. Note, after being enrolled, a customer can't be enrolled. ### Viewing Customer Rewards A customer's available rewards can be viewable on their 360 profile by adding and setting the deep link **Show Redeemable Rewards**. ![A window showing a customer's available reqards showing in the POS app.](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-commerce-retail-264-0-0-production-enus/17d647fb-8988-49fb-9add-c4f4cc79c9e4/retail/images/rt_pos_clienteling_view_loyalty_rewards.png) For app builds 10.10.1 or greater, rewards are split into two categories. These categories are rewards used as discounts, also known as **discounts**. The second category is rewards that can be used in tendering, also known as **Cash**. ![A customers available rewards showing in discounts or cash as options.](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-commerce-retail-264-0-0-production-enus/17d647fb-8988-49fb-9add-c4f4cc79c9e4/retail/images/rt_pos_clienteling_discounts_cash.png) ### Applying Customer Rewards via Cart Deep Link A customer's available rewards can be applied to the cart by adding and setting the deep link **Start Loyalty Reward Payment**. Setting the PS Tag **:ps\_num\_rewards** can also show the number of available rewards. ![The Rewards deep link set in the customer's POS app.](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-commerce-retail-264-0-0-production-enus/17d647fb-8988-49fb-9add-c4f4cc79c9e4/retail/images/rt_pos_clienteling_loyalty_rewards_deep_link.png) Tap a reward in the window to apply it as a discount. To remove the reward, tap on it again. The cart total shows the applied reward and its amount. ![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-commerce-retail-264-0-0-production-enus/17d647fb-8988-49fb-9add-c4f4cc79c9e4/images/icon_note.png) Note Rewards marked as available will be honored, even if expired; the POS app won't perform any validation. To use rewards as a tender, go to the multitender screen. Next, tap **Add** next to Loyalty Reward and select a reward. ![The Available Rewards window in the POS app with a reward highlighted and the Apply Selected Rewards button at the bottom.](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-commerce-retail-264-0-0-production-enus/17d647fb-8988-49fb-9add-c4f4cc79c9e4/retail/images/rt_pos_clienteling_select_loyalty_reward.jpg) ![Important](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-commerce-retail-264-0-0-production-enus/17d647fb-8988-49fb-9add-c4f4cc79c9e4/images/icon_important.png) Important If coupons and transaction discounts are applied to an order, only transaction discounts show in the Cart Summary. Coupons are displayed as an applied promotion.![A cart in the POS app with a coupon applied in the order total.](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-commerce-retail-264-0-0-production-enus/17d647fb-8988-49fb-9add-c4f4cc79c9e4/retail/images/rt_pos_clienteling_loyalty_coupons.png) ### Point of Sale Loyalty Reporting For app builds 9.8.1 or greater, the total loyalty discounts redeemed in a transaction are recorded in CMS and POS app reports. If a reward is applied as a promotion, it'll be reported through all the normal promotion reporting streams. Electronic Journal ![The Loyalty Reporting electronic journal in the CMS.](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-commerce-retail-264-0-0-production-enus/17d647fb-8988-49fb-9add-c4f4cc79c9e4/retail/images/rt_pos_clienteling_loyalty_ejournal.png) Recon Report via POS App ![The Loyalty Rewards Applied report in the POS app.](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-commerce-retail-264-0-0-production-enus/17d647fb-8988-49fb-9add-c4f4cc79c9e4/retail/images/rt_pos_clienteling_loyal_report_pos.png) ## Understand POS Loyalty Restrictions View additional issues that exist with the Point of Sale Loyalty setting. ### PS Tags The replacement of PS tags with their values on the Cart Options layout differs from other layouts. The app only checks and replaces these tags on the Cart Options layout: - **:ps\_num\_rewards** - **:ps\_remaining\_store\_credit** These tags are supported because cart actions can update their values, allowing the display of the latest values after every cart action. However, the **:ps\_current\_loyalty\_points** tag, while configurable, doesn't always function correctly on the **Cart Options** layout because it isn't directly tied to cart actions. It is recommended to configure this tag in the **Clienteling** layout, where it'll be applicable across all flows. ### Summary **:ps\_num\_rewards**: supported on Cart Options layout **:ps\_remaining\_store\_credit**: supported on Cart Options layout **:ps\_current\_loyalty\_points**: supported on Clienteling layout ![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-commerce-retail-264-0-0-production-enus/17d647fb-8988-49fb-9add-c4f4cc79c9e4/images/icon_note.png) Note If configuring the **:ps\_num\_rewards** tag, verify it doesn't have a prefix (for example "Rewards (:ps\_num\_rewards)") as the app won't be able to identify the tag and, therefore, unable to replace it with its value. ## Point of Sale Loyalty FAQs View additional information about loyalty settings in the Point of Sale (POS) app. ### Does Point of Sale apply any logic regarding tiers and what's eligible? No, we don't apply any logic regarding tiers or eligibility. ### Does the expiration come from an external system? What if it's a promotion in your system? Do merchants still send it? Yes, the expiry information comes from an external system. However, if it's a promotion within our system, sending it isn't required. ### Do refunds on orders referenced against a cash transaction discount increment the points? We don't perform calculations in the loyalty system. We show the rewards that are passed on to us. We do handle logic and verify if rewards are active. As long as a reward is greater than the subtotal of the cart, it can be applied. Rewards are posted downstream to the order, so they can be used to mark them as redeemed in the loyalty system. If there's a return, we prorate the reward discount across the cart, and if there are returns, we note that the reward was used as a tender and there was a return against it. The merchant system is expected to handle the rest of the process. Check if your business allows refunds for rewards. ### What about exchanges? Rewards are carried forward in exchanges. For example, if a $100 order had $80 paid in cash/card and $20 in discounts, processing an exchange results in $100 worth of credits to use in the exchange. ### Where is this information recorded? Yes, the TLogs record everything about the order data, including the redemption of rewards. Merchants should refer to the TLogs. ### Can the promotion API endpoints be used for retrieving information? Yes, but only for coupon reward types. ### With the coupons, do we validate them at all other than the incoming code? With a transaction discount, what conditions are required? We don't validate coupons beyond the incoming code. For transaction discounts, they’re required to be active. However, if the code is active but has passed its expiry date, the POS app still honors it and show it as a redeemable reward. ### On TLogs, how are loyalty rewards distinguished from regular coupons? Promo code doesn't distinguish loyalty rewards, only discounts. It's recommended to create a dedicated promo code type to distinguish. For transaction discounts, they'll effectively be treated as their own discount, and recorded in the TLogs. ### Is this recorded in the Electronic Journal (EJ)? Yes, there's a new column for loyalty as a discount in the EJ report.