Basket Object

Basket Object includes the properties of the product(s) in the customer's basket. This object must be implemented on every page that contains the basket, except for the transaction page. After any action involving the basket (adding, removing a product), this object must be updated in every basket.

What are the prerequisites?

• Insider tag must be implemented.
• Insider object must be defined before the Insider tag. Otherwise Insider tag cannot read any information from the Insider object.

What are the properties?

The Basket object has the following properties.

What are the things to keep in mind?

When integrating the object, the following factors should be considered.

• The page should return Basket for the type after running window.insider_object.page.type on the browser console. 
• window.insider_object.basket.total should return the correct basket total.
• When a voucher is applied, the object should also be updated to display the correct value.
• window.insider_object.basket.currency should return the correct currency.

Sample Code

Below is a sample code for the Basket object.

window.insider_object = window.insider_object || {};
window.insider_object.basket = {
    "currency": "USD",
    "total": 277.9,
    "shipping_cost": 9.9,
    "line_items": [
        {
            "product": {
                "id": "N1234",
                "name": "Sleep Mask",
                "taxonomy": [
                    "Skincare",
                    "Moisturizers",
                    "Night Creams"
                ],
                "currency": "USD",
                "unit_price": 100,
                "unit_sale_price": 95.2,
                "url": "https://www.mywebsite.com/en-us/sleep-mask/n1234/",
                "stock": 150,
                "color": "Blue",
                "size": "S",
                "product_image_url": "https://www.mywebsite.com/product_images/n1234.png/",
                "custom": {
                    "season": "Winter",
                    "delivery_time": "In 5 days"
                }
            },
            "quantity": 2,
            "subtotal": 190.4
        },
        {
            "product": {
                "id": "M1234",
                "name": "Beauty cream",
                "taxonomy": [
                    "Skincare",
                    "Moisturizers",
                    "Day Creams"
                ],
                "currency": "USD",
                "unit_price": 90,
                "unit_sale_price": 87.5,
                "url": "https://www.mywebsite.com/en-us/beauty-cream/m1234/",
                "stock": 112,
                "color": "Clear",
                "size": "S",
                "product_image_url": "https://www.mywebsite.com/product_images/m1234.png/",
            },
            "quantity": 1,
            "subtotal": 87.5
        }
    ]
}

In addition to the properties defined in the table above, you can add custom properties to any object. Such properties should be added under the custom object as in the example above.

How can I monitor if it works correctly?

Once you deploy your integration, you can test it via different methods.

Insider Object Integration Wizard

This wizard helps you complete your integration and test it afterwards. If you have already implemented the integration, you can use the wizard only to test it as well. See more on the Insider Object Integration Wizard.

Browser Test

You can visit your website and navigate to a page where you want to test the Page object.

1. Right click on your website to inspect the page.
2. Go to Developer Console.
3. Run insider_object or insider_object.basket to see your object.
4. Make sure that it follows the criteria stated in the properties.