📘

This is the latest version of the WooCommerce Integration. If you are still using the older version, click here.

Installation Steps

1. Go to WordPress admin panel.
2. From Left menu, Navigate to Plugins > Add New plugin.
3. On the page, Search 'Zinrelo' from search bar. It will show you Zinrelo plugin result.
4. Click on "Install Now" button to install.

5. Once the plugin is installed, you have to activate it. Click on "Activate" button.

Once the plugin is activated, you are good to use the plugin features.

Accessing Zinrelo Settings in WooCommerce

To access Zinrelo settings in WooCommerce, follow these steps:

1. Login to WooCommerce Admin.
2. Navigate to WooCommerce >> Settings.
3. In the settings menu, locate the “Zinrelo” tab.

Configure Zinrelo settings page in WooCommerce

Enable/ Disable Zinrelo Integration

Tick or untick the toggle button under "Enable/Disable Zinrelo Integration."

• If enabled, it will display the widget on the website
• If disabled, it will not display a widget on the website.

Authenticating Zinrelo Account with WooCommerce

To authenticate your Zinrelo account, you'll need the API key, key identifier, and partner ID.

Obtain these details from the Zinrelo admin console. For more details, refer to this document.

• Partner ID: Enter the obtained partner ID.
• API Key: Enter the store API key.
• API Key Identifier: Enter the API key identifier.

• Add Custom Attributes: To ensure seamless integration, it is crucial to incorporate two essential custom attributes:
  • Last website visit timestamp (Date Type)
  • External member id (String Type)

Note: For the creation of these attributes, please contact your account manager at [email protected].

Showing Potential Points and Text on Product Page

To display potential points to customers on the product page, enable the “Enable Reward Points Text on Product Pages” toggle button.

Configure the reward text in the “Zinrelo Reward Text On Product Page” text box.

Note: Include {{EARN_POINTS}} in the text to fetch and display potential points.

Showing Rewards in the Cart Page

To show rewards in the cart page, enable the “Enable or Disable Zinrelo on the Cart Page” toggle button.

Configure the reward text displayed with available points in the cart page in the “Zinrelo Text On Cart Text” text box.

Note: Include {{AVAILABLE_POINTS}} in the text to fetch and display available points to customers.

📘

Please Note: There are certain configurations required from Zinrelo's end for couponless rewards. For assistance with such rewards, please reach out to us at [email protected].

Labeling Free Shipping Rewards

Define the label for "Free Shipping Rewards" that appears when customers redeem them. You can customize this label.

Preferred Language Mapping

For multilingual stores, map your store's language to WooCommerce. Separate multiple mappings with commas.

📘

Please note that WooCommerce only supports one language at a time. If you intend to map multiple languages, we recommend creating a separate WooCommerce store for each language. For more details, write to your account manager at [email protected].

Cart Session Timeout

Here you can enter the timeout value for the Zinrelo cart session in minutes.

Enable Auto Reject

• Clients having root access to the server:

Clients having root access to their website are highly recommended to utilize a cronjob to automatically reject redeem transactions.

For root access, the store administrator has to add the below path to their crontab on the server.

*/2 * * * * /usr/bin/php {PATH_TO_WORDPRESS_ROOT_DIRECTORY}/wp-cron.php?doing_wp_cron >/dev/null 2>&1

• Clients without root access to the server:

Clients without root access to the server can enable the auto-reject feature, wherein pending reward points will be automatically rejected upon page refresh.

📘

Please Note:

We highly recommend using a cronjob as it is more reliable.

Once you are done with configuration, click on "Save Changes."

Configuring Rewards

This extension allows the member to redeem reward points and get different types of discounts on various occasions. There are 4 types of rewards available for the redeem.

• Product Redemption
• Fixed Amount Discount
• Percentage Discount
• Free Shipping

Members can choose to redeem one reward and get a discount based on the criteria and conditions set for that reward. If the member doesn't have enough points or has wrong authentication information, the rules won't show up in the drop-down menu. Also, members can cancel a reward they've already claimed and claim it again if they want to.

📘

Note: The rewards will be available to registered customers only.

How do rewards function?

Product Redemption:

When selected, the member will get the free product in his cart and can complete his order with the excluded price of the free product in the order subtotal.

📘

Note:

Please ensure that the requested free product exists in the WooCommerce store; otherwise, this reward will not be applied. Additionally, make sure to hide the free product from the user.

To do this, select the product, edit it, and choose "Hidden" from the catalog visibility settings. Please refer to the screenshot below:

Configuring Product Redemption:

To configure product redemption, follow these steps:

1. Obtain the Product ID by logging into your WooCommerce Admin Console and navigating to Products >> All Products.
2. Hover over the product to view the Product ID.

3. Copy the ID and paste it into the Product ID text box in Product Redemption Reward in the Zinrelo admin console. Ensure the reward is enabled.

📘

Note: To activate this reward, upload random coupon codes to the Zinrelo admin console. There is no need for adding these coupons to WooCommerce as this is a couponless reward.

Fixed Amount Discount:

When selected, the member receives a fixed discount on the order subtotal.

Configuring Fixed Amount Discount:

To configure this reward, follow these steps:

1. In the WooCommerce admin console, navigate to WooCommerce >> Coupons.

2. Click on “Add Coupon” and then "Generate Coupon Code" to create the coupon.
3. Under General, select the “Fixed Cart Discount” type.
4. Specify the amount to be deducted from the member's points once redeemed. Ensure the amount matches in both WooCommerce and Zinrelo admin consoles.
5. Toggle the "Allow Free Shipping" button if free shipping is desired with this reward.
6. Enter the coupon expiry date, configure the usage limits, and publish.

Note: The usage limit per coupon and per user should be 1.

For creating, updating and deleting multiple coupons, you can use WooCommerce API.

Percentage Discount:

When selected, the member will get some percent off applied to his order subtotal.

The configuration is similar to the “Fixed Points” discount. Except “ “Fixed Cart Discount,” select “Percentage Discount.”

Note: Ensure that the coupons added for Fixed Point Discount and Percentage Discount are also added to the Zinrelo admin console. The coupon codes should match in both platforms.

Free Shipping:

When selected, the member will not be charged any shipping charges.

Configuring Free Shipping:

To configure this reward, follow these steps:

1. Log in to the Zinrelo admin console.
2. Create a “Free Shipping” reward and configure it.
3. Once configured, add random coupon codes in the Zinrelo admin console.
4. Enable the reward.

Note: To activate this reward, upload random coupon codes to the Zinrelo admin console. There is no need for adding these coupons to WooCommerce as this is a couponless reward.

Enable loyalty rewards

1. Enable the loyalty rewards module: Turn on this setting to activate the rewards module on your website.

2. Add Partner ID: Provide your store's partner_id. You can find this information in the admin console under General >> Settings.

3. Add API Key: Enter your store's API Key. You can locate this key in the admin console under General >> Settings.

📘

Please Note: The API key will only be visible to administrators with full access.

4. Add Custom Attributes: To ensure seamless integration, it is crucial to incorporate two essential custom attributes:
   • Last website visit timestamp (Date Type)
   • External member id (String Type)

📘

Note: For the creation of these attributes, please contact your account manager at [email protected].

Configuring Webhook

To configure a webhook you will need a webhook url which will be sent by us. To obtain the url write to your account manager at [email protected].

📘

Please Note: It is essential to clearly specify the webhook event for seamless integration.

1. Once you have the webhook URL, log in to your WooCommerce store and navigate to WooCommerce >> Settings >> Advanced >> Webhooks.
2. Click on "Add Webhook" and fill in the following details:
   1. Name: Give a name to your webhook.
   2. Status: Select 'Active'.
   3. Topic: Select the webhook you want to trigger. You need to trigger the following webhooks:
      1. order.created
      2. action.woocommerce_order_partially_refunded
      3. action.woocommerce_order_status_processing
      4. action.woocommerce_order_status_cancelled
      5. action.woocommerce_order_status_refunded
      6. action.woocommerce_order_status_completed
   4. Delivery URL: Add the webhook URL sent by us. For every webhook, the url will be same.
   5. API Version: Select the latest version of the API.
3. Save the webhook.

Please Note:

• You can disable, activate, or pause the webhook as needed.
• For webhooks that are not listed in the topic, select 'Action.' Then, in 'Action Event,' specify the webhook.

Recommendations

For clients supporting online and Cash on Delivery (COD), we recommend the following configuration:

• Award points on order_status_completed
• Return points on order_partially_refunded and order_status_refunded

For clients supporting only online transactions, we recommend:

• Award points on order_status_processing
• Return points on order_status_cancelled, order_status_refunded, and order_partially_refunded

Note: Only one webhook can be created for awarding and returning points.

We recommend the following approach depending on the type of your business:

For businesses utilizing Cash on Delivery:

• Award points upon order completion.
• Return points when orders are either refunded in full or partially returned.

For Online Businesses:

• Award points upon order processing.
• Return points for order cancellations or when orders are either refunded or partially returned.

📘

Please Note:

If you uninstall and reinstall the Zinrelo app. Please inform the Zinrelo team as we will need to make changes in the backend configuration.