# Getting Started
Introduction to Beans marketing applications for e-commerce
Welcome to Beans!
Beans provides you with a variety of tools to help run your marketing and grow your business. It powers you with everything you need to market your products, reach out to more customers, and retain the existing ones. Beans offers:
* [Liana](https://www.trybeans.com/liana): A Loyalty and rewards program application that makes your customers addicted to your shop.
* [Bamboo](https://www.trybeans.com/bamboo): A referral program to turn your customers into advocate of your brand.
* [Foxx](https://www.trybeans.com/foxx): An email automation tool to send targeted emails that drive sales
* [Snow](https://www.trybeans.com/snow): A notification widget that helps communicate with your customers without disrupting their journey
# Add a member
This article will explain how you can manually add members to your rewards program without them signing up on the rewards program page.
## How does it work?
You can manually add members to your loyalty program so they can enjoy the full benefits of the reward program and also get them to actively participate in activities that involve your store increasing your order of sales.
# Adjust a member's balance
How to manually credit or debit points from customers' account
While Beans is 100% automated and fully integrates with your online shop, there are occasions when you may need to adjust a member's balance. For example, you want to use points to refund a customer instead of refunding them in cash. Another use case is to manually redeem points if a customer cannot redeem their points themselves or the redemption request happened after the order was placed. In that case, you can manually deduct the points from the customer's account and apply a coupon code to their order.
#### Steps
1. From the Beans admin interface, go to **Members**
2. Select the account that you would to credit or debit
3. On the top right, click on **Edit** > **Update the balance**
# Deactivating a member
How to remove a customer from your rewards program
Deactivating a member means denying a customer access to your rewards or referral program. A customer can be deactivated either manually or automatically based on their activity.
When a customer is deactivated, they won’t be able to receive emails, earn points, spend points, refer their friends, or access their earned rewards. No data is deleted and you can reactivate the customer's account later if needed.
### Steps
#### **Deactivate a member manually**
1. From the **Beans dashboard**, go to the **Members** page.
2. Locate the member you would like to deactivate and click to open their profile details.
3. On the **Member details** page, click on the **Edit** button, then click on **Deactivate account**. A confirmation message will appear and ask you to confirm. Click on **Deactivate** to confirm the deactivation
Deactivate a member's account
#### **Reactivate a member**
1. From the **Beans dashboard**, go to the **Members** page.
2. Locate the member you want to reactivate and click on them to open their profile details.
3. On the **Member details** page, click on the **Reactivate** button.
Reactivate a member's account
### Automatic deactivation
An account gets automatically deactivated when the customer opts out of the program, or if the delivery of email notifications returns a bad status such as spam reports. If you think an automatic deactivation was an error you can reactivate the account.
# Import members
Import your customers data into Beans using a CSV or directly from supported third party applications
There are 2 ways to import your customers' data into Beans. You can either import them with a CSV file or directly from any supported third-party application. Note that if you have your Shop (Shopify, WooCommerce, etc.. ) connected we will automatically fetch these customers into your Beans account, so you don't have to take any additional steps to import them.
To import your members from a CSV file, just follow these steps.
#### Step 1
From the **All members** page, click on the **Actions** button and choose **Import members** in the dropdown menu.
#### Step 2
Select the source you would like to import your members from. Select **CSV File** to import your members from a CSV file.
***Notes on CSV imports***
If you are importing your data from a CSV file, you will need to make sure that your data are well-formatted. Beans allows you to import custom data using the [custom fields](/members/custom-fields) but you will need to make sure you set up your custom fields before starting the import. Also, you need to make sure that your data contains the **email**, **first\_name,** and **last\_name** columns.
To import a date, we recommend using the international ISO date format: YYYY-MM-DD.
{% hint style="info" %}
Download a [sample CSV file](https://trybeans.s3.us-west-2.amazonaws.com/media/csv/import-customers-test-points-tiers.csv)
{% endhint %}
#### Step 3
Whether you are importing from a CSV file or a third-party app, Beans lets you choose which data you would like to import. You will then be able to select a destination field for the imported data using the **map to field** option. If the field you would like to import your data to does not yet exist, you can use [Custom fields](/members/custom-fields) to add it.
#### Step 4
At last, you will be able to specify which list you would like the imported customers to be added to. You will also get the option to automatically enroll the imported customers into your rewards program, your referral program, or your Newsletter.
# Custom fields
This article will show you how to add custom field to your members data.
Custom fields let you store specialized information about your members. That means you can use them to segment your members to increase your conversion.
A custom field has 2 parts:
* **Name** The name of the custom field.
* **Type:** The kind of information your custom field will store. You can select between **numeric** or **text**
## Creating and managing custom fields
1. From the **Members** page, click on the **Actions** button
2. Click on **Add custom fields**
3\. Click on **Add new custom field**\
4\. Enter the field name and select its type\
5\. When you finished, click on **Save.**
## Custom fields limitations
To make sure you don't lose data when using custom fields, these limitations are applied to them :
* You cannot edit a custom field once it is added.
* You cannot delete a custom field once it is added
# Custom fields on registration
Is it possible to get your customers to provide extra information when they join your rewards program?
Beans integrates directly with your ecommerce platform (Shopify, WooCommerce, etc...). To join your rewards program, customers create a shop account. Once a customer has registered on your shop, Beans retrieves their information and add them to your rewards program. This means that the registration process is handled by your shopping cart system.
If you want to get extra information from your customers you will have to update the registration flow of your shop. This is out of the Beans' flow, but there are other tools that can help you achieve that.
For Shopify, we recommend the [Helium Custom Fields](https://apps.shopify.com/customr) application.
For WooCommerce, the [Custom Fields](https://woocommerce.com/products/custom-fields-for-woocommerce/) plugin.
# Rules
What are rules? How to set them?
Rules let you set actions for which you would like to reward your customers. Using the rules you will be able to define exactly how much points you want to give to your customers when they complete an action that is profitable to your business. You can set as many rules as you like. We recommend you set at least 5 or 6 rules to make your rewards program attractive to your customers.
## Activating a rule
Adding a new rule is relatively easy. Go to the **rules** page from the left menu and activate any rule that you want. Once you have activated a rule you can now edit it and set up details such as the numbers of points you would like to award for that action.
{% embed url="" %}
Activating and editing a rule
{% endembed %}
Some rules require complex logic that cannot only be handle by Liana. You may need to first activate the required application or integration through the Trellis system.
## Setting points value
Once you have activated a rule you can set how much points you want to give to customers for completing the action. By default 100 points are worth $1 or 1 unit of currency depending on your currency. So if your currency is EUR, then 100 points are worth €1. If you decide to give your customers 200 points for signup to your online store it means they will get $2 credit. If you set it to 400 points, it means they will get $4 credit and so forth.
## Deactivating a rule
You can deactivate a rule whenever you want. For the rules page select the rule that you want to disable. Click on the red **Disable rule** button at the bottom left of the screen and confirm.
{% embed url="" %}
Deactivating a rule
{% endembed %}
# Registration
Join our reward program and get X points
The register rule lets you reward customers when they sign up on your online store. It is a very important rule as it is the one that gets your customers to immediately see the value in your rewards program. When customers register, they get the welcome bonus so they don't have to start with a 0 balance. It also can incentivize new customers to complete their first purchase in your shop. It is recommended to set it between 200 and 500 points, depending on your average order value.
### Settings
1. **Points**: The number of points customers get for signing up in your shop.
### How does it work?
Customers will get the points immediately after registering for a shop account.
{% embed url="" %}
Getting points with the Register rule
{% endembed %}
# Loyalty
Spend X dollar to get X points
Use this rule to reward customers with points for placing orders in your store. This is the perfect rule to increase repeat purchases and build customer loyalty. The Loyalty rule allows you to choose the number of points to reward your customers for every dollar spent. We recommend you set it between 5 and 20 points per dollar spent on the store.
Points are calculated based on the value of the order after discounts and before shipping, and taxes. For example, if the subtotal is $100 and the customer uses a coupon code of $20, pays shipping fees of $30, and taxes of $40, they will earn points for $100-20=$80.
## Settings
1. **Points:** The number of points a customer gets for spending $1
# Cart Booster
Get 3 times as many points when you spend more than $X in our shop
The Cart booster rule helps in ensuring your customers return back to your shop, it multiplies the points of customers for purchasing a particular worth of items on your store, If a customer purchases an item or items in a cart worth $400, and your Cart booster is set with a threshold of $400 with a multiplier of 4, the customer will get 4 times the normal points he is supposed to get for the purchase, so Instead of getting 100 points, your customer will get 400 points.
## Settings
1. **Threshold:** The amount the customer has to purchase before the rule of cart booster can be applied.
2. **Multiplier:** The number of times the points will be multiplied.
## How does it work?
Customers will get the points, as soon as they purchase goods worth the amount the retailer set for them to access the reward.
# Facebook Page Like
Like our Facebook page and get X points.
The Facebook Page Like rule helps advertise and make your business. It lets you reward customers that like your Facebook page. It is a very important rule as it allows your customers to participate in activities that fully involve your store on social media.
We recommend you set it between 200 - 500 points. This will help increase the eagerness of the customer to engage with your social media activities.
## Settings
1. **Points:** The number of points a customer gets for liking your Facebook page.
## How does it work?
Customers will get the points immediately after connecting their Facebook account and liking your page.
{% embed url="" %}
# Twitter Follow
Follow us on Twitter and get X points
The Twitter Follow rule helps you reach out to more people on Twitter. It lets you reward customers that follow you on Twitter. It is a very interesting rule as it allows your customers to participate in activities that fully involve your store on social media.
We recommend you set it between 200 - 500 points. This will help increase the eagerness of the customer to engage with your social media activities.
1. **Points:** This is the number of points a customer gets for following you on Twitter.
## How does it work?
Customers will get the points immediately after connecting their Twitter account and following you.
{% embed url="" %}
# Instagram Follow
Follow us on Instagram and get X points
The Instagram Follow rule helps you get more sales from Instagram. It lets you reward customers that follow you on Instagram. It is a very interesting rule as it allows your customers to participate in activities that fully involve your store on social media.
We recommend you set it between 200 - 500 points. This will help increase the eagerness of the customer to engage with your social media activities.
## Settings
1. **Points:** The number of points a customer gets for following your Instagram account.
## How does it work?
Customers will get the points immediately after connecting their Instagram account and following you.
{% embed url="" %}
# Refer a friend
This article will help explain how the 'Refer a friend' rule works and how you can use it to improve your business.
The Refer a friend rule allows you to reward your customers for successful referral invitations in your store. Activating this rule will encourage your customers to invite their friends to make purchases thus aiding revenue generation in your store.
### How does it work
As soon as the customer sends referral invitations to friends, the referrer will be rewarded when the invited friend makes a purchase in the store.
# Accept referral Invitation
This article will explain how the 'Refer a friend' rule works and how you can use it to improve your business.
The Accept Referral Invitation rule encourages potential customers to make purchases in your store. It allows the customers to receive rewards when they accept referral invitation encouraging them to make purchases.
### How does it work?
When potential customers accept referral invitations this rule allows them to be rewarded with referral points they can redeem at checkout and get a discount on their purchase.
# Inactivity
Every X days of inactivity will cost you X points
The Inactivity rule helps keep your business away from competitors and helps keep your customers active on your online store. The Inactivity rule works by discouraging the absence and inactivity of your customers by making them lose a particular number of points for a period of inactivity in your store.
We recommend you to set it between 50 - 70 days. Please note that after the number of days you set the customers will lose some of their points if they have been inactive.
## Settings
1. **Points:** The number of points the customer will lose after a certain number of days as set by the retailer.
2. **Inactivity Period(in days):** The number of days the points remained without been used.
# Celebration
Get X points for the New Year!
The Celebration rule allows you to reward the customer on the new year celebration or any other celebration. This rule compels your customers to wait in your store for a particular celebration. The Celebration rule allows you to select a month and a day in the year to reward customers that have stayed with you for a long period of time as they get to receive reward points at that time of the year.
We recommend you set between 500 - 1000 as it is a once-in-a-year activity and it will increase sales as the customers will want to use their discount to make purchases.
## Settings
# Expiration
All your points will expire after X days
The Expiration rule helps to discourage your customers from just accumulating and pilling of points without redeeming them. The expiration rule majorly helps to set up a time frame where the customer's points will be active and also when the points will expire.
## Settings
1. **Expiration period in days:** The number of days the points will last before they expire, This can vary as set by the retailer.
# Birthday
Stay with us until your next birthday and get X Points.
The Birthday rule lets you reward your customers on their birthday. This is very powerful because it makes them remain in your store for at least one year. You give points to your customers as a birthday gift only if they stay with you from one birthday till the following one.
We recommend you set this rule reward between 500 and 700 points as it will be a good birthday present to brighten up the customers' day.
## Settings
1. **Points**: The number of points customers get for their birthday.
## How does it work?
{% embed url="" %}
Customer can input their birth date on the rewards page by using the **Edit Birth Date** button located on the Birthday rule card.
{% hint style="warning" %}
The birth date must be set at least two days before their birthday.
{% endhint %}
# Tiers
This article explains how the tiers system works in Liana
{% hint style="info" %}
This feature is exclusively available on Beans Enterprise.
{% endhint %}
The Tiers feature lets you create special memberships where customers enjoy different loyalty program benefits depending on their level. Each level is defined by the number of points they earn during a rolling year. You can set up to 3 tiers. We recommend you set at least 2 tiers to make your tiers system attractive to customers.
## Activation
To activate this feature, go to the **Tiers** page from the left menu and activate the tiers that you want. Once a tier is active, it becomes editable and you can set it up according to the needs of your store by changing the default parameters.
**Deactivation**\
If you want to disable a tier, select it and click on the edit button. When you are on the Edit Tier page you will find the **Disable tier** button on the bottom left. Click on it and confirm to remove this tier from your rewards program.
## Settings
1. **Tiers name:** The name that will be displayed to reference this tier on your reward program page
2. **Icon:** The icon that will be used for the tier on the reward program page
3. **Points:** The minimum points to accumulate to reach this tier. For example, if you set it to 5000 points, it's mean that when a customer earns 5000 points during a rolling year, they will automatically be upgraded to that tier.
4. **Points multiplier:** The number of times, the points earned by a member of this tier will be multiplied. If it is set to 2 and a customer was supposed to earn 100 points after a transaction, they will get 200 points. \
5. **Additional benefits:** This is a list of extra benefits that you would like to offer your customer. Examples: Free shipping, Special gift cards, etc. \
**Don't forget to remove the default additional benefits that are added when you activate a Tier.**
When you are done editing the tier settings, click on **Save** to apply the change to your store.
{% hint style="info" %}
Note that changes you made to a tier might take up to 10 minutes to be applied on your shop rewards page.
{% endhint %}
## How does it work?
Once a tier is activated it will display on your storefront reward page. A new section "**Membership**" is added and customers will be able to see information about all the available tiers, what is their current status, and how many points they need to reach to the next tier level.
## Tier member lists
When you set up a tier, a new list is created and automatically updated as new members get enrolled in that tier. To get access to that list you will have to go to your [**Lists** page](https://app.trybeans.com/members/lists) under the **Members** section.
# Display
# Redemption block
How to display the redemption block on the cart page, and how to solve display issues with the redeem button on your store.
By default, Beans will automatically append a redeem block on the cart and/or checkout page, so that customers can easily redeem their points during their purchase.
### **Custom theme**
While Beans supports most themes out of the box, there are some instances where Beans JS will fail to locate the right placement for the redemption block. In those cases, the developer should help Beans scripts find out where the redemption button should be displayed.
Add the following HTML code wherever you want the redemption redemption button to be displayed. Add this tag in your cart page HTML body:
```
```
Tips: You can also manually add the redemption block container if you would like to change the redeem block position.
### **Overlay cart popup**
Since most overlay cart popups are dynamic, it is hard for Beans to know where and when to display the redemption button. In those cases, there is no easy solution. If you can redirect customers to the cart page, we encourage you to do so, especially on platforms like Shopify where the redemption option cannot be displayed at Checkout. Alternatively, you can also make use of our Widget that will let customers redeem from any page on your online store.
# Redemption
# Redeem points
How can customers redeem their points on the store?
By default, the option to redeem points is available on the cart page. If you are using WooCommerce or Shopify Plus it is also possible to allow customers to redeem their points from the checkout page.
### How to redeem points?
First, make sure that you are logged in to the shop with the email you are receiving rewards program notifications at. If you don't have an account attached to that email, please just create one. The system will automatically link it to the right rewards program account using your email. Then go to the cart and click on the redeem button that should be below the cart.
Add a product to the cart and go to the cart page. You will see the option to redeem your points directly on the cart near the checkout button (Make sure that you logged in). Click on the button to redeem your points. Based on the redemption conditions set by the retailer (available on the rewards program page), a discount will be applied to your cart.
Please note that you will not be able to select the number of points that you would like to redeem as the software will automatically select for you the maximum number of points that you are allowed to redeem for that particular purchase.
### Demo
{% embed url="" %}
### Redemption issues
If customers are not able to see the option to redeem their points even after logging into their shop account, it could be that the Beans app is not correctly installed in your shop.
In some cases, customers might not complete their order after redemption, or the order fails due to a declined payment. In those situations, [customers will be refunded their points after a certain delay](/liana/redemption/pending-debits).
# Pending Debits
What is a pending debit and how to cancel it?
### What is a pending debit?
A pending debt occurs when the customer tries to redeem their points. Immediately after redeeming their point during a purchase, a debit is created with the status `pending` . This means that the debt is not yet fully recorded into the customer account's history. Once the customer completes the order the debit status is then moved from `pending` to `committed` and the transaction will appear in the history. \
\
The `pending` state exists to prevent customers from gambling with the system. For example, a customer could try to redeem multiple orders at the same time and get more discounts than they are allocated. \
\
The `pending` debits can be seen in the admin dashboard as explained in the screenshot below.
### How to cancel a pending debit
If the customer cancels their redemption, the `pending` debit is automatically canceled and then the customer gets access to their full balance.
In case the customer exit without completing the order. the `pending` debit is automatically canceled within 48 hours.
# Redemption rate
How does the Liana redemption system works? What are its limitations?
The redemption rate is the conversion rate used to compute the value of the points your customers have accumulated.
The default redemption rate is: 100 points can be redeemed in exchange for 1 unit of your store's currency. If your store currency is USD, it means that for every 100 points customers accumulate, they will get a $1 discount. A customer that has 700 points will get a $7 discount and so on.
The default redemption rate is the best rate to, psychologically, maximize customers' engagement in your rewards program. When a customer has 3,700 points it is very easy for them to understand how much benefit they get when you set a redemption rate of 100 points to $1 instead of 250 points to $1. \
\
It is not currently possible to change the redemption rate, but you can set the maximum discount a customer can get while redeeming and limit the redemption against selected products.
### Frequent Ask Questions
#### Why is the default redemption rate 100 points to $1?
The default redemption rate of 100 points to $1 makes it easier for both the merchant and the shopper to compute the value of points. For example, if you give the customer 5 points for each dollar spent, this would be equivalent to 5% cashback. So it makes it easier to resonate in terms of percentage. It is worth noting that in the Beans system, points can only be integers, so you cannot give a decimal amount of points. So the default rate gives you the best granularity. 1 point is worth ¢1 (one cent).
#### Is it possible to update the redemption rate to 1 point worth $1?
This is a frequent question that we get often from merchants. This is in fact a very bad idea. Since in the Beans system points can only have integers value, this would mean that if you are giving your customers 1 point per dollar spent, they will get 100% cashback. Better list your products for free.
#### What if my local currency is inflated and has a lot of digits?
In some currencies, product prices are already in the thousands. And the default rate of 100 points to 1 unit of currency makes it possible for the customer to have a large digit amount of points, for example, millions or billions of points. While this is not a technical limitation, it can limit the customer experience and cause display overflow in some places. The Beans team is aware of this issue and is working on solutions.
#### Will there be any way in the future to adjust the redemption rate?
At this stage, our team is exploring solutions to make Beans even more accessible to more merchants especially those who are having to work with an "inflated currency". There is a feature request on our [roadmap](https://beans.productlane.io/roadmap) about it. We encourage you to upvote and contribute by sharing your use case.
# Redemption conditions
This article explains how to set restrictions to points redemption.
Setting restrictions for points redemption allows you to control the minimum points required for redemption and the maximum discount customers can receive. By implementing these restrictions, you can fine-tune your loyalty program to balance customer rewards and business profitability.
### Minimum points required for redemption
To initiate a redemption, customers must have a certain minimum number of points in their account. By configuring the minimum points before redemption, you can establish a threshold customers need to meet to redeem their points.
* Keep in mind that the minimum points required should be set appropriately to align with your business goals and customer expectations.
* Example: If you set the minimum points before redemption to 500 points, customers must have a minimum of 500 points in their account to make a redemption.
### Maximum Discount per redemption
The maximum discount per redemption determines the highest discount a customer can avail themselves of when redeeming their points for a purchase. It ensures that discounts granted through points redemption are within acceptable limits.
* When a customer wishes to purchase a product, the maximum discount restricts the percentage of the total price that can be covered by redeemed points.
* Example: If a customer intends to buy a product worth $10 and they possess 1000 points, where 1000 points equal $10, setting the maximum discount per redemption to 50% will limit the customer to a redemption of 500 points, equivalent to a $5 discount.
# Buy products with points
Make it possible for your customers to redeem their points towards specific products.
In addition to letting customers redeem their points for a discount on their purchase, Beans has other reward options. With the "Buy products with points" option, you can allow shoppers to use their points to get a product in your store. This is especially useful if you have a special collection of items that can only be obtained with points. This feature is great at boosting customer participation in your rewards program.
Buy product with points
The Beans admin interface allows you to select the product in your shop that should be exclusively redeemable with points. This means that the products you have selected for the rewards program will no longer be available for purchase in your store through regular checkout. Once you activate that option for a product its price will be displayed in points and a new ***Pay with points*** button will replace the regular ***Add to cart*** call to action. When a customer clicks on it, the product will be automatically added to their cart with a special redemption coupon applied. Note that the customer must be a member of your rewards program and have enough points to redeem for the product.
### Steps
1. From the left menu, go to **Loyalty** **>** **Redemption**
2. Locate the **Buy products with points** section
3. Select products that will be exclusively redeemable with points
4. When you are done, click on the **Save** button
{% hint style="warning" %}
Only products that have been published in your store, and that have a valid price will be available for selection.
{% endhint %}
# Redemption issues
Customers are not able to redeem their points, or the points redemption is not working as expected
When customers redeem their points during a purchase, Beans automatically deduct the points from their account. If the customer does not complete their purchase, the redemption is automatically canceled after a few hours (up to 48h), and the points are credited back to the customer’s account.
### Issue with points deducted after the payment fails
***Reported on Woocommerce***
In some rare scenarios (usually when using an external gateway such as PayPal), the order will be validated in your backend, whereas the payment fails. In this case, customers will only be refunded their points if the retailer cancels the order.
# FAQ
# How are loyalty revenues generated?
The loyalty revenues are income generated from the rewards program in your store. This revenue can be monitored on the analytics page of the application's admin interface.
### What accounts for loyalty revenue?
Orders with redemption will count towards the loyalty revenue.
# Adding Custom CSS
How to add customize your rewards page with CSS?
Custom CSS allows you to fully customize your rewards program to make it fully match your website. You can use custom CSS to add support for your font, your brand colors, and much more.
{% hint style="warning" %}
Add custom CSS, only if you have knowledge of HTML and CSS.
{% endhint %}
To get started go to the advance section for Liana [here](https://app.trybeans.com/liana/advance).\
\
Enter your Custom CSS in the Custom CSS field and save your changes. Be aware that due to caching it might take up to 15 minutes for your changes to reflect on your website.
\
\
\
# Disable checkout auto-redirect
How to disable checkout auto redirection after redemption?
By default customers are automatically redirected to checkout after redeeming their points. However, in some cases, this behavior could be inconvenient.
To disable the auto-redirect:
1. Go to the advance section for Liana [here](https://app.trybeans.com/liana/advance).
2. Look for the **Auto Checkout** option and disable it.
# Enrollment of customers in the rewards program
This article explains how customers are enrolled in your rewards program
### New Customer Registration
By default, new customers that create a store account will become members of your rewards program. If you enable the welcome email for your rewards program, they will receive an email that lets them know they have just joined your rewards program and that explains to them what the benefits are.
### Existing customers
Existing shop customers refer to customers that exist in your shop before you launch your loyalty program. Existing customers will be automatically enrolled in the rewards program once you set it up and activate it. Only customers that have accepted to received marketing emails will be auto-enrolled. Same way as for new customer registration, if you activate the welcome email notification, existing customers will also receive it when they are enrolled in your rewards program.
### Guest customers
Guests are customers that place an order in your shop without creating an account. By default, guest customers are only enrolled in your rewards program if they have checked the option to receive marketing and promotional offers at checkout. Note that some shops may be configured to have this option checked by default. If a guest customer has not accepted to receive marketing offers, they will not be enrolled in your rewards program. Alternatively, you can also [set up an email invitation for guest customers](/foxx/rules) to join your rewards program.
Apart from the auto-enrollment, you can also add members to your programs by either [adding them manually](/members/add-members) or [importing them](/members/importing-data).
# Why do rules have minimum points?
Why do some rules require to set a minimum points value?
Setting the right points amount for each rule can be a tricky exercise. It is important for the merchant to have a cost-effective rewards program scheme while maximizing customer satisfaction.
In order to help you design the best rewards program and minimize shoppers' dissatisfaction, Beans enforces a minimum points value for certain rules. Not all rules have limits.
As a matter of fact, Beans relies highly on email notifications to keep customers engaged. When customers earn points they will be notified by email. For example, if you set up the rule to reward customers on their birthday, customers will receive a notification on their birthday letting them know that they have received points for this special occasion. If the birthday rule is set to a ridiculously low amount of points, for example, 25 points which is equivalent to $0.25, this will upset many customers. Of course, no one wants to wait a whole year to receive a 25 cents discount on their next purchase. And angry customers know how to hurt a brand. Many customers will start reporting the email notifications as spam, and it is hard to blame them. A high rate of spam reports is damageable to your brand and also our servers. This in turn will have a negative impact on email deliverability for all merchants using Beans.
Having a minimum points value per rule ensures that customers are happily engaged and participating in your rewards program.
# Loyalty points calculation
How are points computed for an order? How do taxes, shipping cost, and discounts affect points earned?
When you activate the loyalty rule, members of the rewards program will earn points for each purchase. Points are calculated based on the order subtotal amount. This represents the value of the order after all discount codes have been applied. It is exclusive of taxes and shipping costs that are applied at checkout. However, it is important to note that taxes included in the product's price will not be deducted. Therefore the following statements are correct:
* Customers do not earn points for shipping costs. Shipping costs do not affect how many points customers earn for a purchase.
* Discounts applied at checkout decrease the amount of points customers earn for a purchase.
* Taxes applied at checkout do not affect how many points customers earn for a purchase.
* Taxes included in the product price increase the amount of points customers earn for a purchase.
#### Example
A customer has a cart value of $90. They redeem a $15 coupon code at checkout and are charged $30 in taxes and $20 in shipping costs. This customer will only earn points for $90 - $15 = $75.
# Getting started
Understand how the referral program works, how customers can invite their friends, and how the referrer gets rewarded.
The referral program helps you incentivize customers to recommend your products to their families and friends by rewarding them. Customers get rewarded when they refer a friend to your store that completes a purchase. Referrals are considered successful only when the referred customer is a new customer placing their first order.
Each customer who joins your referral program gets access to a unique referral link. The referral link helps track new customers that are being referred to your store. From the referral page, the customer can email the referral link to their friends or share it directly on Facebook and Twitter. The customer can also click on the copy button to copy the link and share it with their friends on any other platform.
As soon as their friends click on the referral link, they are automatically directed to your store with a popup that says:Your friend (the referrer) is giving you a discount to spend in the store.
```
Your friend (the referrer) is giving you a discount to spend in the store.
```
After registering for an account on the shop, the referred customer will see a popup with the unique coupon code they are rewarded with for accepting the invite. The customer can choose to copy and use the coupon code immediately or they can access it on the referral program page when they are ready to make a purchase.
A referral is deemed successful when the referred customer makes a purchase in the store using the invite link. When there is a successful referral the referrer gets his reward. The referral reward value can also vary depending on your referral settings. The available options are:
* Reward points
* Percentage coupon
# Rules
# Accept Invitation
Accept an invitation and get a $X coupon redeemable on your first purchase.
This rule allows your customers to receive rewards when they accept referral invites from their friends i.e when they click on the link, they are automatically redirected to your store with a popup that shows the discount they get for registering for the referral program.
## Settings
# Successful Referral
Invite a friend and get a $X coupon after they place their first order.
This rule allows your customers to receive rewards when they successfully complete a referral invites i.e when the individual they referred uses the invite link to register for the referral program and makes a purchase the referrer receives his reward.
## Settings
# Display
# Link your referral page to your Shopify store.
Add your referral program to your Shopify store.
The referral program page lets customers join your referral program and refer your business to their friends. We recommend you add a link to your program page directly on your website menu so that customers will know about it.
Here is how to do it:\
# Link your referral page to your Woocommerce store.
Add your referral program to your Woocommere store, this steps are also applicable for adding the reward program to your store.
The referral program page lets customers join your referral program and refer your business to their friends. By default, when the customer installs Bamboo, the referral page is automatically added to the store menu. \
\
However in the case that the page is not automatically added, we recommend you add a link to your program page directly on your website menu so that customers will know about it.
### Here is how to do it:
To add the page on Woocommerce, you need to go to your Woocommerce dashboard. After that, select the pages menu
\
If you want to edit the referral page you should hover this page with the cursor, here you can now see add sub-menu. In this sub-menu, you will click on edit if you want to edit your referral page now you can easily edit the referral page.
However, you shouldn't remove the shortcode. Otherwise, the program page will not display. \
# Conditions
Add extra referral conditions.
Sometimes you want to make your referral program more custom. And you want to add specific conditions before the referral is deemed successful to ensure that your referral program is beneficial to your business as expected. For this case, Bamboo has a **Condition** feature that helps you set extra conditions that will be used to validate the referral program.
#### Minimum Purchase (USD)
The minimum purchase lets you set a minimum amount that the referred friend should spend before the referral be deemed successful. This is the perfect option to make sure that your referral program is profitable.
For example, you want to give a big amount for successful referral such as $20, but you have a large divergence of products in the shop in terms of price: some products cost $10 and other products cost $200. If the referred friend only spends $10 in your shop, you will be giving the referrer a $20 coupon as a reward and you will have lost $10. When you set the minimum purchase you ensure that this cannot happen. With a minimum purchase of $100, you can make sure that the referrer is only rewarded if the referred friend spends at least $100. So you ensure that the minimum profit that you will get out of your referral is $80.
## Settings
# Referrals
You can monitor referrals by seeing how many referral invites were sent & how many invites were converted making it easier for you to track referrals and to see the revenue generated by each referral.
## How does it work?
You can use this link to track referral:\
##
# FAQ
# Adding Custom CSS
How to add customize your referral page with CSS?
Custom CSS allows you to fully customize your referral program to make it fully match your website. You can use custom CSS to add support for your font, your brand colors, and much more.
{% hint style="warning" %}
Add custom CSS, only if you have knowledge of HTML and CSS.
{% endhint %}
To get started go to the advance section for Bamboo [here](https://app.trybeans.com/bamboo/advance).\
\
Enter your Custom CSS in the Custom CSS field and save your changes. Be aware that due to caching it might take up to 15 minutes for your changes to reflect on your website\
# Why registration is enforced for referrals.
You must have noticed that when customer's click the referral link they are asked to register first before they can receive the discount. We put in this measure to ensure that customers are real people, not bots, and also collect their information so we can monitor the referrals, and ensure that only one customer uses the coupon code, and also prevent duplication.
# Can Bamboo be used for affiliate marketing?
What are the differences between a referral program and an affiliate program and why Bamboo is not a good solution for your affiliate marketing?
## Referral Programs vs Affiliate Programs
A referral program is one of the best tools available to grow your D2C brand through word-of-mouth marketing. It is mainly to get your customers to tell about their business to their friends. On the other side, an affiliate program is to help you drive more traffic to your shop by partnering with keys influencers and marketers who will be working on redirecting their audience to your shop.
On the surface, both programs look similar as they are helping you get more potential customers. And in the backend, they seem to work the same way, as in both programs, a unique trackable link to your website is generated to help know who is *referring* customers to your online store. However, these are the only similarities that both programs share. Apart from that, they are quite different from each other.
### Referral Program (word-of-mouth marketing)
A referral program software's main purpose is to increase word-of-mouth marketing. It has some unique features that are not relevant to an affiliate program. Here is a non-exhaustive list:
* **Reward referrals with shop-specific coupons and products.** Referrers in a referral program are already customers in your shop. Otherwise, how would they be able to promote your shop through word-of-mouth? The very principle of word-of-mouth marketing is to share products that you love with people that you know.
* **Send email invitations.** Referrers in a referral program are supposed to know the person that they are inviting to your shop. Therefore they are legally authorized to send email invitations to these people, whereas in an affiliate program, the referrer would have to get prior consent from his marketing list before emailing them.
### Affiliate Marketing
An affiliate program software's main purpose is to make it easier for your influencers and marketers to know how much qualified traffic they are sending to your online shop. Also, influencers are mostly (if not only) interested in the money they are generating from their referrals. So a good affiliate marketing software should take that into account. Here is a non-exhaustive list of feature that you can have with an affiliate program software:
* **Campaign-specific tracking system.** Influencers want to track exactly how much sales they are bringing to your shop with each of their campaigns in order to know which ones are the most efficient. They need an easy way to generate a referral link for each campaign.
* **Commission tracking with cash payment.** Influencers and marketers only want to get paid in cash and are not interested in free redeemable coupons or free products. They expect to receive cash payment through Paypal, or other similar money transfer systems.
### Using Bamboo for affiliate marketing
Bamboo has all of the features needed to power your word-of-mouth marketing. However, it does not have the features required to make your affiliate marketing successful For example, Bamboo does not support cash payment.
There are other tools that are more adapted for affiliate marketing and you can use them alongside Bamboo. It is perfectly fine to have one software for your referral program and another one for your affiliate program since the targeted audience is not the same.
# How to test Bamboo?
This article will help explain how the retailer can test the bamboo application on their store.
To test the bamboo application as a retailer you need to have two devices this is to ensure that the referral program performance is not altered. The first device is the one you use to register as Customer A.\
\
The second device is where you paste the referral link generated when Customer A registers for the referral program.\
\
You can read more about how bamboo works here:\
\
The above link will lead you to the article that explains what you should expect when testing the bamboo application.
# Rules
Automate email notifications for your loyalty and referral program and more.
The notification rules let you set up automated emails for your loyalty and referral programs. This is the recommended way to send email notifications with updates about your rewards program.
A rule represents an event that triggers upon specific conditions. When the condition is met an email is sent to the customer to encourage them to perform an action. In marketing jargon, this is also commonly referred to as transactional emails. As opposed to marketing emails that are sent by the merchant to all or a segment of customers, the transactional email is only triggered for each customer when the set of conditions has been met.
Beans transactional emails feature is designed to help increase the performance of your rewards and referral programs. It is recommended to activate as many as you deem fit as this correlates with better performance for your programs.
#### Using your own transactional emails application
Beans integrates with email solutions such as Mailchimp and Klaviyo. This allows you to synchronize data such as point balance. Although it is possible to set up transactional emails from a third-party application, this is not the recommended solution. Unfortunately, the Beans team is not able to provide you with tailored support when setting up notifications from another application.
[List of integrations](https://www.trybeans.com/integrations)
# Loyalty ▸ Welcome
Email customers to let them know how your rewards program works
This email is sent to new customers who join your rewards program to help them get started and understand how to earn and redeem their points. Once the rule is activated, customers will receive a welcome email when they join the rewards program.
# Loyalty ▸ Balance reminder
Send rewards program balance reminder to customers
This email is sent to customers to remind them about their points balance and encourage them to place new orders using their rewards. Customers will receive reminders about their points balance once this rule is activated. You can also set the frequency you want the reminder to be sent.
# Loyalty ▸ New transaction
Notify customers when they earn new points
This email is sent to customers when they earn new points. It helps customers track their reward points and incites them to shop more often. As soon as this rule is activated, customers will receive emails when rewarded with points.
# Loyalty ▸ Post-purchase invitation
Invite customers to join your loyalty program after they complete an order.
It is common for first-time shoppers to forget to join your loyalty program before placing their first order. This usually happens when the customer checkout as a guest without creating a store account. Beans makes it possible to send a notification email to customers post-purchase in order to invite them to join your rewards program. Customers will receive points for their latest purchase if they accept to join your rewards program.
The email invites customers to create a store account. Once done, they will be added to your rewards program just like a regular member and receive the welcome bonus points, if any. In addition, they will earn points for the order they placed before joining your rewards program.
# Referral ▸ Invitation
Let customers send email invites to their friends
Referral invitation emails help customers send referral invites to their friends. It is the perfect opportunity to design an email to let invited friends discover your products and get them excited about your offer.
# Referral ▸ Referrer reward
Email the referrer with a reward after their friend's purchase
This email is sent to the customer confirming their reward after their friend’s purchase. The referrer will receive the email after the friend accepts the referral invite and makes a purchase using the referral link.
# Referral ▸ Friend reward
Email the friend with their reward after they register on your shop
A friend that receives a referral invite can benefit from an exceptional discount on their first order. The email is sent to the friend as soon as they register using the invitation link.
# Campaigns
This article explains how you Campaigns work inside Foxx
A campaign in Foxx is a one-time set of emails sent to a defined list of contacts. It lets you plan and executes the promotion of your business, with strategy. You can for example reach out to your customers with newsletters, announcements, product deals, etc. Once created, a campaign can be sent immediately, or it can be scheduled for going later at a specific time.
## Creating a campaign
1. From the **Campaigns** page click on **Create campaign**
2. Enter the name that describes your campaign and click on **Create**
3. Now you can set your campaign and define how it will be sent
## Setting a campaign
1. **Campaign name:** The name of the campaign that will be displayed in the Foxx interface
2. **Email Template:** The look and the content of the campaign email. Take a look at[ ](broken://pages/-M6UXHzI_rnICWzXbp9K)this article to see how to edit an email template
3. **Audience:** The target of the campaign. Select among the member list who to send the email to. Learn more about the member's list.
4. **Schedule:** The moment the campaign will be sent. You have 3 choices:
* **Save for later**: The campaign will be saved as a draft. you can come back anytime soon to edit it before sending
* **Send immediately**: The campaign will be sent to the targeted audience as soon as you clicked on the **Send** button.
* **Schedule:** The campaign will be sent on the date you would have selected. Once scheduled it is possible to cancel the campaign, make some edits to it, and then reschedule.
## Deleting a campaign
{% hint style="warning" %}
Once a campaign is scheduled, you need to cancel it before being able to delete it.\
Sent campaigns are not deletable.
{% endhint %}
1. From the **Campaigns** page, locate the campaign you would like to delete and click on the **Edit**
2. Click on the **Delete campaign** red button on the bottom left and confirm.
# Sender email
How to use your company domain to send emails with Beans
## Adding a custom email address
When you email a customer, having an email address that includes your domain name will help you maintain and grow an engaged audience. It increases your customers' trust and also indicates to inbox providers that you are a legitimate sender with a legitimate business. Ultimately, you’ll want your sender's email address to look like **, **, etc.
### Steps
1\. Go to the **Display** page under the **Emails** menu.
2\. Click on the **Edit sender details** button in the **Sender Details** section.
3\. Inside the popup that opens, fill the email address field with your custom email;
4\. Make sure all the other data are correct and click on **Update** to save. Once you update your email address you will be asked to verify that you own that email and domain.
## Verify your email address' domain name
Beans proceeds to your email domain verification to ensure that you have permission to send emails from it. To go through the verification process, you will need to access your domain records. We recommend you log into your domain provider or web host's website or use website management software like cPanel, Plesk, or WHM.
### Steps
1\. Locate the domain name that corresponds to the sender email you have set up.
2\. Click on the **Verify domain** button.
3\. Read the instructions about domain verification to make sure you understand them.
4\. Copy the displayed TXT Record value.
5\. In a separate browser window or tab, navigate to your domain provider's website and find your domain's records.
6\. Create a new TXT record for your domain name and paste the value copied above from Beans into the appropriate fields.
7\. Make sure all the data you entered are correct and save the TXT record.
8\. Navigate back to Beans dashboard and in the **Verify Your Email Domain** popup and click on **Verify.** Please note that, depending on your domain registrar, changes to your domain records can take up to 48 hours to propagate. In most cases, it takes less than 2 hours.
9\. Your email domain will be verified if Beans can confirm your records are updated and correct.
# FAQ
# Replacement tags
In this article you will find the replacement tags that can be used in our email automation app.
Foxx offers replacement tags that can be used to create personalized or dynamic content. It provides certain template variables that you can use to personalize message content. The most commonly used variables are rewards and referral variables, which allow you to dynamically include information about your recipients. For example, their name, referral link, or rewards transaction type e.t.c
### Personalization Tag
Use these merge tags to display subscriber information in your emails and response emails. The following list contains the most common merge tags used in Foxx for personalization.
```
[%first_name%]
```
Inserts your subscriber's first name if it's available in your audience.
```
[%last_name%]
```
Inserts your subscriber's last name if it's available in your audience.
### **Referral Tags**
```
[%referrer_first_name%]
```
Inserts your referrer’s first name if it's available in your audience.
```
[%referral_link%]
```
Inserts the referrer link
```
[%referral_reward%]
```
Inserts the reward the customer receives for a successful referral
```
[%referral_reward_short%] or [%referral_reward%]
```
Inserts the reward the customer receives for a successful referral
### Reward Tags
```
[%liana_transaction_type%]ed
```
Inserts the transaction type either credited or debited.
```
[%liana_transaction_points%]
```
Inserts the points the customer gets from the transaction type.
```
[%liana_points_value%]
```
Inserts the points value in the store's currency
```
[%liana_points_balance%]
```
Inserts the customer's point balance
```
[%liana_transaction_description%]
```
Inserts the transaction the customer was either debited or credited for.
```
[%liana_transaction_sign%]
```
Inserts the numerical sign of the transaction showing if it was a debit(-) or a credit(+)
### Others
```
[%unsubscribe_link%]
```
Inserts the unsubscribe link\
\
\
\
# Sender address
This article explains how you can change the address on the Foxx email template.
You might want to update the address that your customers will see when they get an email from your rewards program, referral program, or email campaigns.
To change or update the address, you need to update the billing information you registered while creating an account with Beans. \
\
You can do this here:\
After updating the information click on **`continue`** to save.\
\
For the changes to reflect in Foxx click on the **`reset`** button in the email template, there you will now see the updated address.
# Gmail's warning messages
This article explains why you might see a yellow warning banner in your test emails sent with Beans.
When you use Beans to email yourself or a coworker, you might see a yellow ribbon warning. This is a Gmail feature designed to prevent spoofing. It occurs when the domain in the “From” email address matches that of the recipients’ email domains. This likely happens when you send emails to members of your team sharing the same email domain (@yourcompanyemail.com). It does not impact emails sent to people outside of your organization. Therefore your customers will likely not see that warning message.
# Testing email notifications
How to test email notifications
Testing email notifications is a great way to make sure they are set up correctly. Beans makes it easy to send yourself and your teammates sample emails.
### Steps
1. From the Beans admin interface, in the left menu, under **Emails** click on **Rules**. Locate the email notification that you would like to test and click on the **Edit** button.
2\. Click on the **Edit Email** button.
3\. On the top right, click on **Test email.** Enter the recipients' emails and click on **Send**.
# Social Connect
Let customers login to your store with their Facebook or Twitter account
Arrow adds social media login to your shop so you can let customers connect via Facebook or Twitter. The social login buttons are located on the Login/Signup page and are displayed when Arrow is active.
# Display
This article explains how to manage the display of social login buttons
You may want to not display all of the social media login buttons on your Register/Login page. The display feature in Arrow lets you decide which one of the buttons you want to be shown on your store.
## Hide/Show a social media button on your store
1. From the **Display** page in Arrow, locate the social media button you want to display/hide in your store.
2. Click on the switch to turn the button display on/off.
{% hint style="info" %}
Note that changes in your display settings can take up to 10 minutes to be applied to your shop.
{% endhint %}
# Widget
Position and beautify your notification widget
The display section allows you to position your notification widget, where you want it to be , you can either position it at the bottom left or the bottom right.\
Here you can also select a theme for the icon as there are different options , also you set the color of the icon to suit your store here.
## Settings
## How does it work?
{% embed url="" %}
# Messages
You can add messages to be displayed on your store here, this notification widget allows you to display important information at the exact page and time you want them to see it. There is the default message that comes with the app if you have installed Our Loyalty or Referral app or both, asides the the default messages you can add and customize your message.
## Settings
**Add message** : This allows you to add the messages you want the customer to view.
## How does it work?
{% embed url="" %}
\
# Getting Started with Integrations
This article explains how to extend Beans by integrating with the other tools you are already using.
Beans let you integrate with a diverse set of applications to get the most out of its features. \
All available app integrations are accessible on the **Integrations** page in the dashboard.
## Add an integration
1. Go to the **Integrations** page
2. Locate the app you want to connect to and click on it
3. On the popup that shows up, click on the button **Connect**
4\. Then just follow the different instructions to get the app connected. The process may vary from an app to another. Take a look at our list of **Integrations**, to learn more about each of them.
## Disconnect an integration
As you are adding new integrations, you may want to remove an existing one or change its linked account. It is simple to achieve this by disconnected the involved integration.
1. Go to the **Integrations** page
2. Locate the app you want to disconnect in the list of active integrations and click on it
3. On the popup that shows up, click on the button **Edit**
4\. From the following page, click on **Disconnect** and the app integration will be deactivated.
# Shopify
# Referencing Shopify pages
Add a link to the rewards and referral program page in your site menu
The Shopify navigation tool allows you to dynamically set up a navigation menu for your website.
Your website can have many menus. For example, The Main menu at the top lets your customers quickly access important pages on your shop such as collections and there is the footer menu at the bottom that lets them access other pages such as about-us.
We recommend you add the link to your program in the Main menu in order to make it easy for your customers to access.
Here is how to do:\
\
# Enable customer accounts
Let customers sign up and login to your shop
In order to get the app to work as expected, it is recommended to enable customer accounts for your Shopify Store.
Shopify gives you the option to set customer accounts as disabled, optional or required.
We recommend you set it to **optional** or **required**.
Here is how to enable customer accounts with Shopify:
# Template Migration
This section is very optional and, in most case, is not needed.
Template Migration is used to help the app easily authenticate customers when they are logged in to your shop. By default, the app will automatically migrate your templates for you. So you don't have to do anything. In case you would like to migrate your template by yourself, here is how to do it.
If this is your first time editing Shopify template, please make sure to read and understand how to edit Shopify template:
Edit the **layout/theme.liquid** to include the following code. Place the code just in the head before the closing **\** tag
```
```
So the final result will look like this:
Don't forget to click on **save**.
# Shopify OS 2.0
Set up Beans on Shopify Online Store 2.0 theme
{% hint style="info" %}
This article is only useful if you have an [Online Store 2.0 theme](https://help.shopify.com/en/manual/online-store/themes/managing-themes/upgrading-themes#download-an-online-store-2-0-theme-from-the-shopify-theme-store)
{% endhint %}
If you are using a Shopify Online Store 2.0 theme, it is critical to enable the Beans app in your Shopify theme. The new Online Store 2.0 is a recent improvement released by Shopify to make it easier for app developers to integrate fully with a merchant Shop.
You are required to enable Beans in your Online Store 2.0 theme so that your customers can access and use the app functionalities on the storefront.
### Steps
1. From the **Shopify dashboard**, go to your **Themes** page.
2. Locate the **Current theme** section and click on **Customize**.
3. Click on **Theme Settings**, go to the **App Embed** tab then locate the **Beans Ultimate** app extension and switch it on.
# Using discount codes with redemption
This article explains how Shopify merchants can manage discount codes conflicting with points redemption.
Beans rewards program uses discount coupons to apply points redemptions. When a customer tries to redeem their points, a discount code is generated and is applied to their cart.
### Shopify (classic)
If you are using the classic version of Shopify (not using Shopify Plus), Shopify does not allow your customers to use multiple discounts at checkout. Therefore if a customer wants to redeem their points, they will not be able to use another discount code.
### Shopify Plus
For Shopify Plus merchant, there is an option to use multiple discount codes at checkout. You will need to get in touch with Shopify to have the feature activated for your store.
Even if you decide to let your customers use multiple discounts code at checkout, you should keep in mind that discount codes can be mutually exclusive. This means that the usage of one discount code can prevent a customer to apply another discount code if both discount rules do not match. This is especially true for the rewards program if you have activated custom redemption rules such as cart discount limitation or minimum points condition.
# Shopify POS
Does Beans support Shopify POS?
Officially speaking we do not fully support Shopify POS, but this in our pipeline. Here is what we already support:
* When a customer completes a purchase and provides their email address and accepts to receive marketing email they are automatically enrolled in your rewards program.
* When a customer completes a purchase and provides their email address and accepts to receive marketing or is a member of your rewards program they will automatically be credited for the order (assuming you set up a loyalty rule).
The following features are not supported:
* Redemption on POS is not supported. You are still able to debit your customers manually from the Beans interface.
Depending on your order volume you may still want to use Beans with your Shopify POS, knowing that the redemption process is not yet integrated. If you do, please let us know if you face any bugs.
# Shopify Limitations
##
## Shopify API rate
Shopify uses three different methods for managing rate limits. Different APIs use different methods depending on the use case.
The various types of rate limits your apps will encounter are:
* **Request-based limits**: Apps can make a maximum number of requests per minute. For example 40 API requests within 60 seconds. Each request counts equally, regardless of how much or how little data is returned. This method is used by the REST Admin API.
* **Time-based limits:** Apps can make requests that take a maximum amount of time per minute. For example 120 requests within 60 seconds, with each request taking 0.5 seconds to return. More complex requests take longer and therefore take up a proportionally larger share of the limit. This method is used by the Storefront API.
* **Calculated query costs:** Apps can make requests that cost a maximum number of points per minute. For example 1000 points within 60 seconds. More complex requests cost more points and therefore take up a proportionally larger share of the limit. This method is used by the GraphQL API.
Our application communicates with Shopify via their REST API and Shopify limit API calls per second so there is a number of customers that can redeem at the same time.\
For example, if your shop has a lot of traffic and many customers try to redeem their points at once this can lead to a Shopify Rate Limitation making customers unable to redeem their points. To solve this they simply have to wait and try again a few minutes later.\
\
To read more about Shopify API Rate Limitation click [here](https://shopify.dev/concepts/about-apis/rate-limits)
# Uninstallation
How to properly uninstall the Beans application on your Shopify store.
Go to your Shopify admin and confirm that Beans appears on the list of applications on the Apps page.
1\. Click on Delete to remove the application from your store.
2\. Remove the pages for your loyalty program or referral program that were automatically created by the Beans app.\
a. From your Shopify admin, navigate to the Pages Section (Online Store > Pages)\
b. Look for the Rewards Program page and delete it \
c. Look for the Referral Program page and delete it
3\. The last step is to clear the authentication snippet. \
a. Navigate to Online Store > Themes select Edit code in the Actions dropdown
b. Open the **theme.liquid** file\
c. Look for the following line and remove it:
```javascript
```
d. Make sure to save your changes.
# Shopify customers tags
Tagging your Shopify customers with their VIP tier levels
The[ **Tiers**](https://help.trybeans.com/liana/tiers) feature allows you to create special memberships where customers can enjoy different loyalty benefits depending on their level. Whenever a member has met a certain set of conditions their tier status is updated. They can be promoted to a higher tier or downgraded to a lower tier.
Beans automatically add tag customers in Shopify with their current tier level. This allows you to view directly in Shopify which tier a customer belongs to. It also makes it easier to segment customers by their loyalty tier. For example, if a customer becomes a member of the Gold tier, the tag **Beans-Tier-Gold** will be added to that customer in the Shopify dashboard.
{% hint style="info" %}
This feature is activated by default when you enable the tier feature and have connected your Shopify store.
{% endhint %}
# Woocommerce
# Account Synchronization
Customers who have already created an account with your store will automatically be synchronized with the rewards or referral program no later than 24 hours after the application has been installed.
# Referencing WooCommerce pages
This article explains how to add a link to the program page on your store navigation menu
WordPress has a drag and drop menu interface that you can use to dynamically set up a navigation menu for your website.
Your website can have many menus. For example, the Main menu at the top lets your customers quickly access important pages on your shop such as collections and there is the footer menu at the bottom that lets them access other pages such as about-us.
We recommend you add the link to your program in the Main menu in order to make it easy for your customers to access.
Here is how to do:\
# Setting up permalinks
In some cases, you might experience a bit of difficulty connecting our plugin to your store and this issue can be caused by :
**Your permalinks configuration**\
\
When you have an issue displaying a 404 status, it means the application is unable to find these URLs in your shop.
**To settle this issue:**
1. Connect to your WordPress dashboard.
2. Navigate to Permalinks under the settings menu.
3. Under the common Settings section check Post name
4. Scroll down and click on the Save button.
####
### Here is a video explaining how you can do this:
{% embed url="" %}
If the issue persists, please contact our support team.
# Edit Beans pages
How to add additional information to the rewards program page
Beans plugin for Woocommerce automatically adds a rewards page to your shop. By default, you can access the page at `http://myshop.com/rewards-program`, assuming your website's full URL is `http://myshop.com`.
To display the rewards program page Beans use the shortcode `[beans_page]` . That makes it very easy to add any additional information to that page.
1. From your WordPress backend, in the left menu click on **Pages** **>** **All pages**.
2. Look for the page **Reward Page** and click on edit.
3\. Add the additional information in the text editor without getting rid of the shortcode `[beans_page]`**.**
4\. Click on **Update** to save your changes
If your rewards page is not in the menu, take the opportunity to add a link to it, so that customers can easily access it.
# Updating your shop domain
This article explains how to handle website domain update for WooCommerce merchants.
In order to ensure a secure service, Beans needs to verify that the data received from your shop are authentic. This helps ensure that there is no data tampering occuring in the requests. To do that, Beans verifies that the domain sending the data is the domain set by the retailer when they create their account.
The caveat is if you update your WordPress site or WooCommerce shop domain, Beans will not know about it and will reject new data coming from your updated shop. To fix this, you need to update the domain attached to your account. Here is how to proceed:
1. Make sure that you are logged in to your Beans admin dashboard
2. Go to the [advanced WooCommerce settings](https://connect.trybeans.com/radix/woocommerce/settings/) page
3. Update the new domain associated with your website and save
If you get this error message, please try to reinstall the Beans plugin in your store.
4\. Once you are done, go to the [general settings](https://app.trybeans.com/settings/general) page and update the link to your website as well. Make sure to save.
Once you complete these steps, Beans will now be able to accept data sent by your shop and the app should now be working as expected. If you are still having issues after this, do not hesitate to reach out to our support team for assistance.
# Manually Installing Beans
This article explains how to connect Beans manually to your WooCommerce store.
In some cases, due to your server configuration, you might be unable to set up Beans on your WooCommerce. When this happens you can try the manual connection by following the guide below.
Before you begin, make sure you are both logged into your Beans admin dashboard and your WordPress admin dashboard.
1\. Go to **WooCommerce > Settings > Advanced > REST API** and click on **Add key**
2\. Generate the API key and select \`Read/Write\` permissions
3\. Go to [the manual installation page](https://connect.trybeans.com/radix/woocommerce/setup) and paste the consumer secret and consumer key into the displayed form.
4\. Click on Save to complete the setup.
5\. Finally, go to your WordPress Admin dashboard and navigate to the Beans section. The plugin will be connected and ready for use.
After following this process, if you are still unable to connect Beans to your store, reach out to our support team for further assistance.
# Reset and reconnect
Troubleshoot and reconnect the Beans plugin in your WooCommerce shop
For the Beans plugin on WooCommerce to work as expected, it has to be connected to the Beans servers. This helps synchronize the rules you have set up, the email notifications, and many other features.
In some rare events, the plugin seems connected but is not working as expected. This can happen after a WordPress or WooCommerce update or a Beans plugin update. To fix this issue, reset the plugin settings and reconnect Beans on your shop.
### Steps
{% hint style="info" %}
Before starting, ensure you have installed the [last version](https://wordpress.org/plugins/beans-woocommerce-loyalty-rewards/) of the Beans plugin for WooCommerce.
{% endhint %}
1. Go to the Beans plugin page in your WordPress admin backend
2. Click on `Go to Beans Ultimate` button on the top right. This ensures that you are logged in to your Beans account.
3. Click `Reset settings now`on the bottom right.
4. Follow the setup instructions and reconnect your account.
# Caching issues
Issues with rewards and referral program not loading due to cache
Many WordPress websites rely on caching to deliver good performance to visitors. While caching is very advantageous to improve website traffic, it has the inconvenience to be hard to debug especially for dynamic websites.
In the majority of cases, it is recommended to not cache dynamic pages, because the version of the page cached can be outdated or inaccurate. There are 2 types of pages on a website: static pages and dynamic pages. A static page is static as the name suggests, meaning that its content does not change. On the opposite, dynamic pages change often and therefore are not suited for being cached.
We recommend excluding the rewards program page and the referral program page from your caching system because they are dynamic pages that do not display the same content for each customer.
Here is a step-by-step instruction on how to achieve that with **WP Rocket**.
* Go to **WP Rocket > File Optimization** section
* Uncheck all checkboxes in the **JavaScript Files** section and save
* Go to **Advanced Rules** option and add these lines into **Never Cache URLs** section:
```
/rewards-program/(.)
/referral-program/(.)
/my-account/(.*)
```
* Scroll down and save.
* Clear your cache and go to the program pages in your store.
### Console error
Beans scripts should always be loaded from Beans' official CDN. Caching Beans scripts may result in console errors. While it is recommended to not cache Beans scripts, Beans may function as expected even while being cached. If you decide to use a cached version of Beans you may get this error message in your browser's console, which can be ignored.
```
Uncaught TypeError: Cannot read properties of undefined (reading 'Radix')
```
# Connection Issues
How to fix connection issues when trying to connect your store to Beans
Beans plugin uses Woocommerce API to provide you great services that help you sell more. However, when connecting our application to your store. We check to confirm that all the required configurations are working as expected**.**
## **Case HTTP Status: 200, 401**
If you have got a 401 HTTP status and your website is password-protected, you are using a “coming soon” or “site under construction” plugin that is disabling public access to your store. This also disables API access and our applications need this to work. Temporarily disable it in order to connect our plugin to your store. After that, you can reactivate it again.
For example, if this is your store link , follow the instructions below:
1. Go to and then confirm that you see a page that looks like the image below.
2\. Now go to and then confirm that you can see a page that looks like the image below.
* Now you can use this link to connect and follow the normal process. **Replace** [**https://www.example.com**](https://www.example.com) **with your domain name**.
### How it works
{% embed url="" %}
If the issue persists, please contact our support team and attach a screenshot.
## **Case HTTP Status: 0**
Sometimes, when we are checking the configuration, we receive a status 0 which means that when the application tried to connect with your store an issue was encountered. Most of the time, this situation occurs when the SSL certificate on your website is not valid. You can renew your SSL certificate and try again.
## **Case HTTP Status: 404**
This article will help explain in details how to settle an issue with error 404\
[**https://help.trybeans.com/e-commerce-integration/woocommerce/connecting-beans-application-to-woocommerce-stores**](https://help.trybeans.com/e-commerce-integration/woocommerce/connecting-beans-application-to-woocommerce-stores)
## **Others cases**
Here is a list of some of the issues and how you can settle them:
* Your store is using the old WooCommerce version 3.9 or an older version. Make sure you upgrade to the latest WooCommerce version before installing our plugin.
* For the plugin to work, WordPress needs to be installed at the domain or subdomain level, not at the page level. For example, If you are developing a store for a client and you’re creating a mockup on `www.example.com/dev/`. Our server will try to connect to the WooCommerce API at the subdomain level `www.example.com` but the store is on `www.example.com/dev/`. As an alternative, you can install the development store on the`dev.example.com` subdomain, with this our applications will connect to the store as expected.
* You have a caching plugin in your store that strips the “Authorization” header. To settle this try disabling your plugins one after the other to find the one that is causing the issue.
If you’ve tried all the above, It might be that your server is stripping the “Authorization” header.
As this pertains to the configuration of your web server and other WordPress plugins, Beans cannot provide support in these cases. You can try the suggestions below. Please always consult with a web developer when making configuration changes.
In some cases adding the following to your `.htaccess` file might help:
```
SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1
```
If this information does not help, please review the configuration of your caching plugin and look for the settings that pertain to caching or not caching headers.
If after doing all of this the issue persists please contact your hosting provider.
##
# Facebook Integration
If you are getting an error message while trying to connect your Facebook account to Liana using the Arrow app. You have to accept all the requested permissions for your Facebook page to be connected to your rewards program.\
If you didn't do this, you will need to un-authorize the app from Facebook by following the guide here: \
and then retry to connect.
# Judge.me Integration
This article explains how you can integrate Judge.me with the Beans.
Judge.me collects, manages, and displays product reviews for you; including in-email review forms, pictures, social push, rich snippets, Google Shopping, All Reviews Page, product groups, and more, you can integrate our application with Judge.me so your customers will be rewarded with points when they write a review in your store.
You can connect the Beans App with Judge.me in the integration section here:
To connect the applications you will need to input your API private token gotten from Judge.me
\
When you put in your API token you will be able to integrate Judge.me with our application. However, you need to be on the Awesome plan to reward your customers for product reviews.
### How Does It Work?
{% embed url="" %}
# Mailchimp Integration
This article will help explain how you can integrate Mailchimp with Beans.
Mailchimp is a marketing automation platform and an email marketing service. You can integrate your Mailchimp account with Beans to ensure your email subscribers in Beans are always synchronized with your MailChimp account.
### How does it work?
You can integrate Mailchimp with our application in the `Integration` section of the admin interface.
### What can you do with Mailchimp?
When you have successfully connected, we allow you to import your list of members from Beans to Mailchimp and also ensure that this list always stays synchronized.
### **Requirement**
On the Mailchimp free plan, you are limited to one list which is created by default when you create your account. To be able to import your members from Beans to Mailchimp you need to ensure that you haven't reached the limit of lists you can create on your plan. To fully benefit from the integration, you need to be on the Mailchimp paid plan.
# Omnisend Integration
This article explains how you can integrate Omnisend with Beans.
Omnisend is an all-in-one email marketing automation platform for eCommerce businesses. You can integrate your Omnisend account with Beans to ensure your email subscribers in Beans are always synchronized with your marketing list in Omnisend. You can also use this integration to import your marketing lists from Omnisend when you want to migrate to Foxx.
### How does it work?
When you go to the [**Integrations** ](https://app.trybeans.com/trellis)page, you will see the Omnisend integration and you will be able to connect the two apps. [Learn more about Integration](/integrations/trellis-app)
When you have successfully connected, we allow you to import your list of members from Beans to Omnisend and also ensure that this list always stays synchronized.
###
# Sendinblue Integration
This article will help explain how you can integrate Sendiblue with the Beans application.
SendinBlue is an email marketing solution for SMB (small and medium-sized) businesses that want to send and automate email marketing campaigns. You can integrate your Sendinblue account with Beans to ensure your email subscribers in Beans are always synchronized with your marketing list in Sendinblue.
### How does it work?
When you have successfully connected, we allow you to import your list of members from Beans to Sendiblue and also ensure that this list always stays synchronized.\
\
To Integrate our application with Sendiblue you will need your unique API V3 key you can get it here:
# Weglot Integration
This article will show you how to integrate weglot with the beans applications.
**Weglot** is a SaaS tech start-up that helps businesses turn their websites multilingual. To successfully integrate Weglot with the Beans applications, you need to ensure that you have installed the app in your Shopify store and the language switch button appears in your store.\
\
Here is the Weglot guide to set it up in your Shopify store:\
After you have successfully installed the app, you need to go to the Weglot app settings, To do this:\
Go to the App section of the Shopify Admin and click on Weglot.
When you click on the Weglot app other options will appear, you need to scroll down through the other options, there you will see the option labeled Dynamic elements.
### To Integrate With Liana
Add the rewards program page container id (#liana-rewards-page). In the Input labeled Dynamic elements.\
For Liana, you will be adding: **#liana-rewards-page**
Click On Save.
### To Integrate With Bamboo
Add the referral program page container id (#bamboo-referral-page) and the Bamboo popup container id (#bamboo-popup-container) in the dynamic element section, You need to add them individually.\
For Bamboo you will be adding:\
**#bamboo-referral-page**\
**#bamboo-popup-container**
Click On Save.
### To Integrate With Arrow
Add arrow button class (.beans-arrow) and arrow popup class (.beans-arrow-popup).\
For Arrow you will be adding:\
**.beans-arrow**\
**.beans-arrow-popup**
Click On Save.\
\
To test if the Weglot integration works for Arrow\
\
Go to your store Login/Register page and switch the language. Confirm that the Connect with Facebook button text is translated to the currently selected language.
For the translations to be 100% effective you need to ensure that you activate English as your store language in the admin interface. With this, the integration will work as expected.
## Integrating Weglot On Shopify Checkout Page
The Poppy app has a pop-up that appears on the checkout page, In order for Weglot to be able to translate the Popup that appears on the checkout (thank\_you) page, A Weglot script must be loaded on that page.\
To do so, first obtain the JavaScript code snippet by following this guide :\
\
Here is a video explaining how you can get the JavaScript code snippet from Weglot:
{% embed url="" %}
After you have successfully gotten the code snippet you need to add it to the checkout page. To do this go to the checkout page located in the settings section of the Shopify admin.\
Here is a direct link: [ https://www.shopify.com/admin/settings/checkout ](< https://www.shopify.com/admin/settings/checkout >)
Scroll down to the Order processing section, in the input labeled **Additional scripts,** paste the Weglot snippet as shown in the below screenshot.
Click Save.
Here is a video showing how you can add the code snippet to the Shopify checkout page.\
\
\
\
After you have successfully added the coding snippet on the Checkout page the Popup will be translated to the language you select.
# API
Integrate Beans with a custom e-commerce solution.
Beans offers a comprehensible and very easy to use API to help integrate with your custom online store.
#### Storefront Integration
The storefront integration helps you integrate Beans on your online store. This script will display information to your customers (for example the loyalty program page) and also track customers' interactions (for example tracking referrals).
[Add Beans to Storefront](broken://pages/-MDyw4cx84C4zV6fn3LA)
#### Webhooks Integration
Webhooks are a simple way for Beans to be notified when a new event happens in your store (for example when a customer completes an order). They are used by Beans to perform event-based actions such as rewarding a customer after a purchase.
[Setup Beans Webhooks](/integrations/api/webhooks)
# Webhooks
Setting up Beans Webhooks for your online shop
Incoming webhooks are a simple way to let Beans know about new events in your shop, such as when a customer completes an order so that they can be rewarded for their loyalty. They are simple URLs to which you send a JSON payload with the message text and some options.
### Customer Webhook
Customer Webhook is to let Beans know when a new customer registers in your shop. To post new customer information to Beans just use an HTTP POST request like this one:
#### Customer data
```javascript
{
"id": 1847,
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"is_newsletter": True,
"tags": ["loyal", "paying"],
"created_at": "2020-02-06T12:49:47-05:00",
"updated_at": "2022-02-06T12:49:47-05:00",
}
```
#### Create or update a customer
```bash
curl https://hooks.radix.trybeans.com/v3/hook/radix/vanilla/customer/hook_created \
--request POST \
--user :sk_xxxxxxxxxxxxxxxxx \
--header "Content-Type: application/json" \
--data '<>'
```
#### Delete a customer
```bash
curl https://hooks.radix.trybeans.com/v3/hook/radix/vanilla/customer/hook_deleted \
--request POST \
--user :sk_xxxxxxxxxxxxxxxxx \
--header "Content-Type: application/json" \
--data '<>'
```
### Order Webhook
Order Webhook is to let Beans know when a new order is placed in your shop. To post new order information to Beans just use an HTTP POST request like this one:
#### Order data
An order can contain a customer object.
```javascript
order_data = {
"id": 13207,
"currency": "USD",
"email": "john.doe@example.com",
"ref": "13207",
"total": "53.00",
"subtotal": "33.00",
"amount_shipping": "20.00",
"amount_giftcard": "0.00",
"amount_tax": "0.00",
"cancelled_at": None,
"processed_at": "2022-02-06T12:49:47-05:00",
"is_fulfilled": False,
"is_refunded": True,
"is_paid": True,
"customer": {
"id": 1847,
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"is_newsletter": True,
"tags": ["loyal", "paying"],
"created_at": "2020-02-06T12:49:47-05:00",
"updated_at": "2022-02-06T12:49:47-05:00",
}
}
```
#### Create or update an order
```bash
curl https://hooks.radix.trybeans.com/v3/hook/radix/vanilla/order/hook_created \
--request POST \
--user :sk_xxxxxxxxxxxxxxxxx \
--header "Content-Type: application/json" \
--data '<>'
```
# Storefront
Setting up beans.js on your online store
Beans.js is a lightweight library that allows you to integrate Beans Ultimate on any ecommerce store. It allows you to add all the Beans apps to your online store with a few lines of code. It also allows great flexibility if you want to customize the storefront display.
### Including beans.js
Include the beans.js script on each page of your store. It should always be loaded directly from , rather than included in a bundle or hosted yourself.
```
```
The public\_id is a unique identification key that represents your shop. You can get it by reaching out to Beans customer support.
### Initializing beans.js
The following script will help Beans identify the currently authenticated user. Include this script on every page of the store.
```
```
* **window\.beans\_cjs\_id:** Represents the id of the currently authenticated customer and should be dynamically set.
* **window\.beans\_cjs\_email:** Represents the email of the currently authenticated customer and should be dynamically set.
```
const config = {
currentPage: '',
onLogin: () => (window.location = '/login'),
onRegister: () => (window.location = '/register'),
liana: {
onAbout: () => (window.location = '/rewards'),
pagePlaceholder: document.getElementById('rewards'),
},
bamboo: {
onAbout: () => (window.location = '/referral'),
pagePlaceholder: document.getElementById('referral'),
},
};
```
* **currentPage:** Should contain the current page, should be one of the following: \
*product|cart|checkout|login|register|reward or* empty for the other pages
* **onLogin:** This should be a function that redirects to your store login page. In the example above the login page is located at */login*. Make sure to replace it with the right location if it is not the one used in your store.
* **onRegister:** This should be a function that redirects to your store registration page. In the example above the registration page is located at */register.* Make sure to replace it with the right location if it is not the one used in your store.
* **liana.onAbout:** This should be a function that redirects to your store reward program page. In the example above the reward, program page is located at */rewards.* Make sure to replace it with the right location if it is not the one used in your store.
* **liana.pagePlaceholder:** On the page created for the rewards program, you should create a container for beans.js to render the program page inside. *pagePlaceholder* should contain that container. In the example above the container has been named rewards, add the following HTML snippet to the rewards program page to use the same value for *pagePlaceholder.*
```
```
* **bamboo.onAbout:** This should be a function that redirects to your store referral program page. In the example above the reward, program page is located at */referral*. Make sure to replace it with the right location if it is not the one used in your store.
* **bamboo.pagePlaceholder:** On the page created for the referral program, you should create a container for beans.js to render the program page inside. *pagePlaceholder* should contain that container. In the example above the container has been named *referral,* add the following HTML snippet to the referral program page to use the same value for *pagePlaceholder.*
```
```
Just below the initialization data add the following line to initialize beans.js
```
Beans3.Radix.init(config);
```
You have just integrated beans with your storefront. The reward and referral program page should now display on your store.
---
[Next Page](/llms-full.txt/1)
