Creating Buy-One-Get-One-Free Coupons

Use the Scriptable Cart to create a buy-one-get-one-free sales promotion for the web store.

You can use SuiteScript to add a free item to the order when the shopping cart contains an item you identify as the trigger item. By entering the coupon code you specify in the script, the shopper triggers the addition of the free item to the shopping cart. The script becomes inactive when the coupon expires, or when the item is out of stock.

Setup

Use the steps below to create the promotion code and set up the item records required to run the sample script.

This sample script is triggered to add a free computer mouse to the order, when the shopper enters BOGO as the coupon code, and the impressivo computer system exists in the shopping cart.

To use the code sample successfully, you must complete the following setup steps.

1. Create a promotion code named BOGO. Entering the coupon code will trigger the script to run.

   Go to Commerce > Marketing > Upsell > Promotions. For more information about entering promotion codes, see Promotions.

2. Select the item that must be in the shopping cart to receive the free item.

   Go to Lists > Items. Click Edit next to an item.

   This item's internal ID must be referenced in the script. In the code sample below, this is the Impressivo System (internal ID 5).

3. Select an item to offer free of charge when the Impressivo System is added to the cart.

   Go to Lists > Items. Click Edit next to an item.

   Reference the internal ID for the free item in the script. The free item in the sample is a computer mouse (internal ID 59)

Create the Code

          // BEGIN CUSTOM FUNCTIONS FOR BOGO 
function customInit(type)
{
//nlapiLogExecution('ERROR', 'Logging is working', 'Message from script using new execute log API');
return;
} 

        

          // Note that the customOnChange function will trigger on a FieldChanged client event. 
function customOnChange(type, name, linenum)
{
if (name == 'promocode')
{
bogo('commit');
}
}
function customRecalc(type, action)
{ 

        

          // In SuiteScript for the web store, action can only be 'commit' or 'remove.' 
if (type == 'item')
{
bogo(action);
}
}
// END CUSTOM FUNCTION FOR BOGO 

        

          // BEGIN BOGO 
function bogo(action)
{
   var mouseId = 59;
   var impressivoId = 5;
   var promoEnabled = isNotEmpty(nlapiGetFieldText('promocode')) && nlapiGetFieldText('promocode') == 'BOGO'; 

        

          // Verify the computer (Impressivo) and the free mouse exist in the list of items in the order.

 var freeMouseLine = -1;
   var freeMouseQty = 0;
 
   var impressivoLine = -1;
   var impressivoQty = 0;
   var numItems = nlapiGetLineItemCount('item'); 

        

             // Do not do any processing if adding a free mouse.
if (nlapiGetCurrentLineItemValue('item', 'item') == mouseId &&
      nlapiGetCurrentLineItemValue('item', 'rate') == 0 && action == 'commit')
   {
      debug('Adding free mouse - no processing');
      return;
   } 

        

             // Search the sales order for the trigger item and the free item.
for (var line = 1; line <= numItems; line++)
   {
      var itemId = nlapiGetLineItemValue('item','item',line);
      var itemQty = parseInt(nlapiGetLineItemValue('item', 'quantity', line)); 

        

                // If a mouse is found with a rate of 0.00, this is the free mouse.
if (itemId == mouseId && nlapiGetLineItemValue('item','rate',line) == 0)
      {
         freeMouseLine = line;
         freeMouseQty = freeMouseQty + itemQty;
      } 

        

                // If an Impressivo is found, remember the line number and quantity.
if (itemId == impressivoId)
      {
         impressivoLine = line;
         impressivoQty = impressivoQty + itemQty;
      }
   }
   debug('Action '+action+' mouse line='+freeMouseLine+' qty='+freeMouseQty+' impressivo line='+impressivoLine+' qty='+impressivoQty); 

        

             // If the shopper enters the BOGO coupon, and the Impressivo is in the shopping cart, and the
// free mouse is not in the shopping cart, add the mouse to the shopping cart free of charge.
if (promoEnabled && impressivoLine > 0 && freeMouseLine < 0 && action == 'commit')
   {
      debug('Adding free mouse'); 

        

          // Insert the mouse
       nlapiSelectNewLineItem('item');
      nlapiSetCurrentLineItemValue('item', 'item', mouseId, true, true);
      nlapiSetCurrentLineItemValue('item', 'quantity', impressivoQty, true, true);
      setCurrentLineRate(0); 

        

                var desc = nlapiGetCurrentLineItemValue('item','description');
      nlapiSetCurrentLineItemValue('item','description', desc+' (FREE)', true, true);
      desc = nlapiGetCurrentLineItemValue('item','description');
      debug('New description is '+desc);
      nlapiCommitLineItem('item');
   } 

        

          // If the BOGO coupon is no longer valid, and the shopping cart contains the free mouse and    
// the Impressivo computer, remove the free mouse.
if (!promoEnabled && action == 'commit' && impressivoQty > 0 && freeMouseLine > 0)
   {
      debug('Selecting free mouse line');
      nlapiSelectLineItem('item', freeMouseLine);
      debug('Deleting free mouse on line '+freeMouseLine+' because of change in promo code');
      nlapiRemoveLineItem('item', freeMouseLine);
   } 

        

             // If the trigger item (Impressivo computer) is deleted from the cart, then remove the free mouse form the shopping cart. 
if (action == 'remove' && impressivoLine < 0 && freeMouseLine > 0)
   {
      debug('Selecting free mouse line');
      nlapiSelectLineItem('item', freeMouseLine);
      debug('Deleting free mouse on line '+freeMouseLine+' because of deletion of the impressivo');
nlapiRemoveLineItem('item', freeMouseLine);
} 

        

          // If the trigger item quantity does not match the free item quantity in the cart, then update
// free item quantity to match the trigger item quantity. 
if (action == 'commit' && impressivoLine > 0 && freeMouseLine > 0 && impressivoQty != freeMouseQty)
{
debug('Updating mouse quantity to '+impressivoQty);
nlapiSelectLineItem('item', freeMouseLine);
nlapiSetCurrentLineItemValue('item', 'quantity', impressivoQty, true, true);
nlapiCommitLineItem('item');
}
debug('Bogo script complete');
}
function debug(msg) { alert(msg); }
// END BOGO 

        

          // BEGIN UTILITY FUNCTIONS 
function isEmpty(val)
{
return (val == null || val == '');
}
function isNotEmpty(val)
{
return !isEmpty(val);
}
function getVal(colName, linenum)
{
return nlapiGetLineItemValue('item',colName,linenum);
} 

        

          // This function updates the rate and also recalculates the correct value for amount. 
function setCurrentLineRate(rate)
{
nlapiSetCurrentLineItemValue('item', 'rate', rate, true, true);
var qty = parseInt(nlapiGetCurrentLineItemValue('item', 'quantity'));
var amount = qty * rate;
nlapiSetCurrentLineItemValue('item', 'amount', amount, true, true);
} 

        

          // This function returns a map with the internal ID for the item as the
//key  and the totalquantity for that item in the value. It sums items 
//when the same item appears on different lines on the sales order. 
//If passed a non-null filter value, item types that match the filter are excluded.
function getItemMap(excludeFilter)
{
if (isNotEmpty(excludeFilter))
{
debug('getItemMap called with filter '+excludeFilter);
}
var itemMap = new Array();
var numLines = nlapiGetLineItemCount('item');
for (var i=1; i<= numLines; i++)
{ 

        

          // Include only items that match the filter. 
var itemType = nlapiGetLineItemValue('item','itemtype',i);
if (isNotEmpty(excludeFilter) && itemType == excludeFilter)
{
debug('Ignoring line '+i+', itemType '+itemType+' excluded');
continue;
}
var itemId = nlapiGetLineItemValue('item','item',i);
var nextQty = parseInt(nlapiGetLineItemValue('item','quantity',i));
debug('Item'+itemId+' of type '+itemType+' added to item map');
if (itemId in itemMap)
{ 

        

          // Add the quantities if other lines in the sublist include the same item. 
nextQty = nextQty + parseInt(itemMap[itemId]);
}
debug('Item Id '+itemId+' has updated quantity to '+nextQty+' because of line #'+i);
itemMap[itemId] = nextQty;
}
return itemMap;
} 

        

          // This function rounds the input to two decimal places. 
function roundOff(amount)
{
   return Math.round(amount*100000)/100000;
}
// END UTITLITY FUNCTIONS 

        

Deploy Your Script to the Shopping Cart

NetSuite recommends that you test your script thoroughly before running it in the shopping cart. You must follow a series of steps to load the script into your NetSuite account, and then run the script for testing purposes.

For details, see Deploying and Running Scriptable Cart.

.

General Notices