How To
Customer Groups

7min
﻿
To accommodate variable pricing and/or visibility for specific customer group, we will introduce two additional parameters to every API request.
priceFieldSuffix
visibilityGroupID
See: Modify Request Overview﻿ for details on preparing for Klevu JS overriding
See :  Klevu API Documentation for Customer Groups﻿
Indexing
The additional currency pricing data must be supplied at the product level during catalog indexing.
﻿
XML FEED example
Below is a FEED XML example for specific group visibility
XML
 <item>
 . . .
 
      <price>123.45 GBP</price>
      <sale_price>100 GBP</sale_price>
            
      <groups>
            <group>
                <id>vip_customer_group</id>
            </group>
      </groups>
. . .
 <item>
 . . .
 
      <price>123.45 GBP</price>
      <sale_price>100 GBP</sale_price>
            
      <groups>
            <group>
                <id>vip_customer_group</id>
            </group>
      </groups>
. . .
﻿
Below is a FEED XML example for specific group visibility and/or variable pricing
XML
 <item>
 . . .
 
      <price>123.45 GBP</price>
      <sale_price>100 GBP</sale_price>
            
      <groups>
            <group>
                <id>vip_customer_group</id>
                <price>49.99 GBP</price>
                <sale_price>49.99 GBP</sale_price>
            </group>
      </groups>
. . .
 <item>
 . . .
 
      <price>123.45 GBP</price>
      <sale_price>100 GBP</sale_price>
            
      <groups>
            <group>
                <id>vip_customer_group</id>
                <price>49.99 GBP</price>
                <sale_price>49.99 GBP</sale_price>
            </group>
      </groups>
. . .
﻿
If you intend to use multiple currencies in addition to group variable pricing and/or visibility, please review the Template JS Multi-Currency﻿ guide for more details
﻿
Template JS Override
The desired group visibility and/or prices are applied to all queries via overrides using the "all" scope value.
See: Modify Request Overview﻿ for details on preparing for Klevu JS overriding
Example 1 
Exclude all records which do not belong to the group
JavaScript
<script type="text/javascript">

    // The selected customer group <id> 
    var klevu_loginCustomerGroup = 'vip_customer_group';


    klevu.modifyRequest("all", function(data, scope){
      klevu.each(data.request.current.recordQueries, function(key, query){
        klevu.setObjectPath(query, "settings.visibilityGroupID", klevu_loginCustomerGroup);
      });
    });
    
 
</script>
<script type="text/javascript">

    // The selected customer group <id> 
    var klevu_loginCustomerGroup = 'vip_customer_group';


    klevu.modifyRequest("all", function(data, scope){
      klevu.each(data.request.current.recordQueries, function(key, query){
        klevu.setObjectPath(query, "settings.visibilityGroupID", klevu_loginCustomerGroup);
      });
    });
    
 
</script>
﻿
API Parameter
Description
Format
visibilityGroupID
Exclude all records which do not belong to the group
{GROUPID}
See :  Klevu API Documentation for Customer Groups﻿
﻿
Example 2
Apply the specific customer group pricing for the appropriate currency
JavaScript
<script type="text/javascript">

// the currency and group of the currently logged in customer
  var klevu_currency = 'GBP';
  var klevu_loginCustomerGroup = 'vip_customer_group';

  /* IMPORTANT FOR BIGCOMMERCE APP USERS ONLY 
   * The login groupid will need an ajustment for the delimeter
   * 
   * klevu_loginCustomerGroup = klevu_loginCustomerGroup.replace("_", "--");
   * 
   */
   
   
   klevu.modifyRequest("all", function(data, scope){
      klevu.each(data.request.current.recordQueries, function(key, query){
        klevu.setObjectPath(query, "settings.priceFieldSuffix", klevu_currency + '-' + klevu_loginCustomerGroup);
      });
   });
 
 
</script>
<script type="text/javascript">

// the currency and group of the currently logged in customer
  var klevu_currency = 'GBP';
  var klevu_loginCustomerGroup = 'vip_customer_group';

  /* IMPORTANT FOR BIGCOMMERCE APP USERS ONLY 
   * The login groupid will need an ajustment for the delimeter
   * 
   * klevu_loginCustomerGroup = klevu_loginCustomerGroup.replace("_", "--");
   * 
   */
   
   
   klevu.modifyRequest("all", function(data, scope){
      klevu.each(data.request.current.recordQueries, function(key, query){
        klevu.setObjectPath(query, "settings.priceFieldSuffix", klevu_currency + '-' + klevu_loginCustomerGroup);
      });
   });
 
 
</script>
﻿
API Parameter
Description
Format
priceFieldSuffix
Fetch prices/currency specific to a customer group
{CURRENCY}-{GROUPID}
See :  Klevu API Documentation for Customer Groups﻿
Updated 08 Nov 2023
Did this page help you?
Add-To-Cart Function
Facet Option Order
Docs powered by Archbee
TABLE OF CONTENTS
API Parameter	Description	Format
visibilityGroupID	Exclude all records which do not belong to the group	{GROUPID}