Plugin settings

In the Customization section, you will be able to edit all the options to adapt your plugin style to your website.

It’s made of multiple sections:

• General
• Points in shop pages
• Points in product page
• Points in My Account
• Points in Cart & Checkout
• Labels

General

Let’s start with the General section where you can enable one option only if you want to hide all messages to guest users on the frontend.

This is particularly useful if you want to set up your loyalty programme and gamification strategies only for registered users.

Points in shop pages

From this section, you can configure the texts and colors of what appears on the frontend on the Shop page, archive pages (like category or tag pages), and on the product page.

Let’s check all the available options.

• Show points messages in shop pages (loop): enable this option to show the points message on all archive pages (Shop, category and tag pages).
• Loop message: you can use the standard editor to customize the text and upload also media files. You can also use the following available placeholders:
  • {points} number of points earned;
  • {points_label} of points;
  • {price_discount_fixed_conversion} the value corresponding to points
• Colors: finally you can customize the colors of the text, background and border of this message.

Points in product page

• Show points messages in product page: with this option you can show a custom message on the product pages and inform your users about how many points that product will allow them to collect.
• Update the message when the product quantity changes: enable this option to show the point message updated when the user changes the product quantity.

• Message position: choose the position where this message will appear among:
  • Before “Add to Cart” Button (as in the image below)
  • After “Add to Cart” Button
  • Before excerpt
  • After excerpt
  • After product meta
• Single product page message: you can use the standard editor to customize the text and upload also media files. You can also use the following available placeholders:
  • {points} number of points earned;
  • {points_label} of points;
  • {price_discount_fixed_conversion} the value corresponding to points
• Colors: finally you can customize the colors of the text and background of this message.

Points in My Account

• Show points on My Account: enable to show the My Points section on My account page. This will add an endpoint in the My Account section that will look like this:

Here you can see a visual summary showing:

• Points. In the first tile, you can see points available to redeem (1218 in the screenshot above) and the total points collected so far, including the ones that have been redeemed (2968 in the screenshot above).
• Your level (if any achieved): the level will be calculated from the total collected points.
• Your rank in the general rankings. The position in the ranking will be calculated from the total collected points (ever, month, week, day).

Then, you will see four tabs for:

• Points history: a table with all the points-related actions, so points earned through orders, points redeemed, for target achievements, extra points, coupons generated and so on (see screenshot above).
• Targets to achieve: in this tab, you can see the banners that inform your users about the achievable targets. It automatically shows all the Target banners here, and optionally Simple banners (based on the banner settings).

• Get points: in this tab, you can see all the Get points banners, so the ones that inform your users about extra actions they can take to earn more points, like reviewing a product or referring a friend. Optionally, you can also show Simple banners here (this can be done from every Simple banner settings).

• Manage points: here is where you can generate a coupon code from your points and see all the generated coupon codes.

Let’s check the other options in the Show points in My Account settings:

• Label for points section: here you can change the name of the Points section in My account.

• Endpoint for points section: enter the endpoint of the Points section in My account page. Endpoints cannot contain any spaces or uppercase letters. Default to: my-points.
• Show points value: enable this option to make sure that the money worth of points is shown on the product page and in the tile in My account summary. This will encourage your users to buy as they can see the discount that they can accumulate on a future purchase.

• Show points in My Account: enable this option to show points earned and spent in My Account > Order details.

• Show points in email: enable this option to show points earned and spent in the Order completed email.

Points in Cart & Checkout

• Show points in Cart page: enable to show the points message on the Cart page.
• Message text in cart: you can use the standard editor to customize the text and upload also media files. You can also use the following available placeholders:
  • {points} number of points earned;
  • {points_label} of points;
  • {price_discount_fixed_conversion} the value corresponding to points

• Show points in Checkout page: enable this option to show the points message on the Cart page.
• Message text in checkout: you can use the standard editor to customize the text and upload also media files. You can also use the following available placeholders:
  • {points} number of points earned;
  • {points_label} of points;
  • {price_discount_fixed_conversion} the value corresponding to points

Labels settings

Here, you can edit many of the texts of the plugin with your own text. You can find the list of all available labels below.

• Singular label replacing ‘point’: default ‘point’
• Plural label replacing ‘points’: default ‘points’
• Order Completed
• Order Processing
• Order Cancelled
• Admin Action
• Reviews
• Registration
• Target – Total Points: default ‘Target achieved – Points collected’
• Target – Total Amount: default ‘Target achieved – Total spend amount’
• Target – Total Orders: default ‘Target achieved – Total Orders’
• Target Checkout Total Threshold: default ‘Target achieved – Checkout Total Threshold’
• Birthday: default ‘Target achieved – Birthday’
• Daily login: default ‘Target achieved – Daily Login’
• Registration by referral: default ‘User registration by referral’
• Removed registration points due to a referred user cancellation
• Purchase by referral
• Removed points due to a referred user cancellation
• Collected Points
• Level Achieved: default ‘Target achieved – Level’
• Profile Complete: default ‘Target achieved – Profile Completed’
• Expired Points
• Order Refund
• Order Refund Deleted
• Redeemed Points: default ‘Redeemed Points for order’
• Shared Points: default ‘Shared point with a coupon’
• Apply Discount Button: default ‘Apply discount’
• Applied Points Discount Label: ‘Redeem points’

Go to YITH > Points and Rewards > Emails to enable, configure and edit the two emails sent by the plugin.

Expiring points

The first one you find is to inform your user about their expiring points. You can set how many days before the points expiration it has to be sent and customize the content.

Use the following placeholders in the text to recover customer information dynamically:

• {username}: customer’s username
• {first_name} = customer’s first name
• {last_name} = customer’s last name
• {expiring_points}: number of expiring points (as not all points might have the same expiry date)
• {label_points}: the text that you have set up to replace the default one “Points”
• {expiring_date}: point expiry date
• {total_points}: current points balance
• {shop_url}: URL of the shop
• {discount}: value of the discount
• {website_name}: website name

To edit other details of this email, go to WooCommerce > Settings > Emails and click on Expiring Points.

Here you can change the sender’s name and email address, subject (you can also use placeholders here), any additional recipient, email heading, description and type.

This is an example of how the email sent to customers will look like.

When points expire, this information will be registered in the operation table, both for users and shop administrators.

Updated points notification

On the same page, you can also edit the email that is automatically sent to customers and make sure it’s sent:

• either once a day if points have been updated
• or as soon as points balance is updated.

When selecting the option As soon as points are updated, you can choose not to send the email when points are manually updated by the admin by enabling the option Avoid email sending for manual update.

You can choose whether to enable this notification or not and edit the content, where you can also use the following placeholders:

• {username}: customer’s username
• {first_name} = customer’s first name
• {last_name} = customer’s last name
• {latest_updates}: this prints a list with the latest updates to the points balance
• {total_points}: this prints the current balance
• {shop_url}: shop URL
• {website_name}: website name

The plugin includes multiple shortcodes and widgets.

1. Shortcode – Customer rankings
2. Shorcode – Available points
3. Shortcode – My points
4. Shortcode – Product points
5. Shortcode – Points for cart total
6. Shortcode – Referral link
7. Widget – Customers points
8. Widget – Balance
9. Backend widgets

1. Customer rankings

From the Ranking tab in YITH > Points & Rewards > Points options > Ranking, you can find the 2 styles of the customer ranking shortcode ready to copy and paste, but let’s see all the available options.

This shortcode allows you to print the ranking of your customers wherever you want on your website. The ranking lists top users of your store who have collected the most points.

This is the shortcode:

[ywpar_customers_points style="simple" tabs="yes" num_of_customers="3"]

Attributes available

style: this can either be simple or boxed.

tabs: this can either be yes or no.
If set to yes it will show the tabs All time, last year, last 30 days, this week, today.
If set to no, it will show the list of users as All time with the number of points on the right.

num_of_customers: here you can enter the number of customers to show in the rankings. It will automatically show only the ones with the most points.

The total number of points is calculated out of the total points they have earned in their history/week/month, regardless of how many points they have already redeemed (which would be instead their points balance).

So, for example, this week, Paul earns 1000 points, Mark 500 and Tony 300. Paul will be the first in the ranking, even if he has redeemed all his points to get a discount, while Mark and Tony still have not used them.

For the weekly ranking, the lists are updated every Monday.

2. Available points

[yith_ywpar_points]: shows remaining points to logged-in users;

Parameters are:

– label: default value “Your credit is “
– show_worth: default value “no”

E.g. [yith_ywpar_points label="Your credit is " show_worth="no"]

3. My points

[yith_ywpar_points_list]: shows the content of points as it appears in My Account, so points, levels, rank position recap tiles and the tabs with point history, target and get-point banners, and coupons.

4. Product points

[yith_points_product_message]: shows points that will be earned if you purchase the displayed product.

You can either use it as is on a product page, and it will automatically show the points of that product, or use it on other pages and specify the product_id like this:

E.g. [yith_points_product_message product_id="488"]

5. Points for cart total

[yith_checkout_thresholds_message]: shows the number of assigned points based on the extra points rule for total in cart. Check here for more details about how to set up this extra points rule.

Parameter:

title: default value “Checkout total thresholds”

E.g. [yith_checkout_thresholds_message title="Checkout total thresholds"]

6. Referral link

[ywpar_referral_link user_id=”]: shows the referral link by using the user ID or retrieving it automatically by setting the user_id as “auto” > [ywpar_referral_link user_id=auto]

The available parameters are:

• title: default value “Share to earn”
• subtitle: default value “Your referral link”

7. Customers points

From the widget area in Appearance > Widgets, you can pick the Customers points widget.

You can configure:

• title
• style: simple or boxed
• number of customers to show

8. Balance

You can configure:

• title
• label: the text displayed before the number of points

9. Backend widgets

In WordPress Dashboard you will be able to find two extra widgets, available only for the admin, that show:

1. Best point earners: the top users who have collected the most points
2. Best rewards: the top users who have redeemed the most points

By clicking on the View history button, you will open the user’s profile where you can edit the points and check the full points history.

The plugin supports the following multi-currency plugins:

• YITH WooCommerce Multi Currency Switcher
• WooCommerce Multilingual (4.2.9 or higher)
• WooCommerce Currency Switcher (v. 1.2.4 or higher)
• Aelia Currency Switcher for WooCommerce 

and lets you configure a different number of points for each currency.

Whenever you create new rules for awarding (Points options > Points assignments) and for redeeming points (Redeem options > Points redeeming), you will see one field for each currency available in your shop, like this:

The same configuration is replicated in the Points rules and Redeem rules and for each role in your shop:

Or for every Extra points setting where you can set a conversion from points to money or vice versa.

For further details about the configuration of YITH Multi Currency Switcher plugin, please, refer to the official documentation.