Overview
General Set Email Subscribe Email Info Send Brand Send Category Add To Cart Add To Wishlist Checkout Ids Click Image Comment On Product Remove From Cart Save Order Send Product Set Cart Url Visit Help Page
CSV Feed
Product Feed
PHP SDK
PHP SDK
API Integration
Add Subscriber Remove subscriber Subscriber status Send Email Feedback Discounts Generate Discounts Unsubscribed Emails
API For Partners
Shopping Carts AOV Transactions Facebook CPA Google CPA Traffic Source

addToCart

This function must be called every time a product is added to cart.

If you redirect to another page (e.g. the checkout page) right after the user added the product to cart, the add to cart must be set in the function of the callback function, right after the data has been sent to Retargeting (see the examples of the addToCart function).

If add to cart is possible in other pages too, other than in the product details page, you must first call the sendProduct function (for the product that will be added to cart) right before you call the addToCart function (see the examples of the addToCart function).

In the following paragraphs of the addToCart function, we will talk about "variations" of the products. Variation of a product is the product properties group the user has to choose when he is willing to add a product to cart: color, size, capacity, etc. For example, an online fashion store can set a system based on color and size variations: "Y - 32" (yellow color and size 32), "R - XS" (red color and size XS), "M" (size M) etc. 

   _ra.addToCart(product_id, quantity, {
       "code": "color-size",
       "stock": stock,
       "details": {
           "var_code_option": {
               "category_name": "var_code_option_category_name",
               "category": "var_code_option_category_unique_token",
               "value": "var_code_option_value_name"
           },
           ...
       }
   }, callback_function);

Executing scripts automatically when the page is loaded

    var _ra = _ra || {};

   _ra.addToCartInfo = {
       "product_id": product_id,
       "quantity": product_quantity,
       "variation": {
           "code": "color-size",
           "stock": stock,
           "details": {
               "var_code_option": {
                   "category_name": "var_code_option_category_name",
                   "category": "var_code_option_category_unique_token",
                   "value": "var_code_option_value_name"
               },
               ...
           }
       }
   };

   if (_ra.ready !== undefined) {
     _ra.addToCart(
         _ra.addToCartInfo.product_id,
         _ra.addToCartInfo.quantity,
         _ra.addToCartInfo.variation
     );
   }

addToCart function parameters

Field Type Required Description
id number or text True The ID of the product.
quantity number or text True Product quantity.
variation object / false True object with details about chosen variation details for the product added to cart. If the product does not have variation send false value. The object containing the details of the chosen variation has the following properties: code, details
variation.code text True unique combination of properties that form the variation of product, separated by simple line (-). It is mandatory to use a simple dash (-) to separate the options of variation.
variation.stock bool True false - out of stock, true - in stock
variation.details object True The product name
variation.details.variation_code_option.category_name text True object that contains details about each variation option. Object details contains properties with the name of the property codes variation, and each property is an object containing the following properties: category_name, category, value
variation.details.variation_code_option.category text True Unique token or unique id of the category to which it belongs variation_code_option property code
variation.details.variation_code_option.value text True Full name of the variation_code_option property code
callback_function function False With this parameter you can define a function that runs itself after the action's parent function executes.

Examples

send add to cart event for a product without variation adding to cart is done in the product page

   _ra.addToCart(50, 1, false, function() {
       console.log("the information has been sent");
   });

executing scripts automatically when the page is loaded.

   _ra.addToCartInfo = {
       "product_id": 133,
       "quantity": 1,
       "variation": {
           "code": "42-B",
           "stock": true,
           "details": {
               "42": {
                   "category_name": "Size",
                   "category": "size",
                   "value": "42"
               },
               "B": {
                   "category_name": "Color",
                   "category": "color",
                   "value": "Black"
               }
           }
       }
   };

   if (_ra.ready !== undefined) {
       _ra.addToCart(
          _ra.addToCartInfo.product_id,
          _ra.addToCartInfo.quantity,
          _ra.addToCartInfo.variation
       );
   }