GuidesAPI Reference

Afterpay Site Messaging

How can I add Afterpay Site Messaging to my product and cart pages?

🚧

These instructions require editing code! Before making any changes to theme template files, back up your current theme customizations.

There are 2 types of Theme Platform on BigCommerce. Stencil & Blueprint.
Follow the instructions below according to which Theme Platform your store uses.

See Which Theme Platform do I have? if you are unsure which theme platform your store uses

Stencil

  1. Go to Storefront › Script Manager
  2. Click Create a Script.
  3. Set up the following:
  • Name of Script: Afterpay Messaging
  • Description: Place Afterpay Site Messaging on product and cart pages
  • Location on page: Footer
  • Select pages where script will be added: Store pages
  • Script category: Essential
  • Script type: Script
  • Load method: Default
  1. Copy and paste the below script into Script Contents:
<!-- Begin Afterpay Stencil Snippet for BigCommerce v3.1.1 -->
<script>
{{#or (if page_type '===' 'product') (if page_type '===' 'cart')}}
    (function(){
        const supported = ["AUD", "NZD", "USD", "CAD"];
        const currency = '{{currency_selector.active_currency_code}}';
        if (supported.indexOf(currency) > -1) {
            {{#if page_type '===' 'product'}}
                let targetSelector = '.productView .productView-price';
            {{#if product.price.with_tax}}
                let priceSelector = '.productView-price .price--withTax';
                let cachedAmount = '{{product.price.with_tax.value}}';
            {{else}}
                let priceSelector = '.productView-price .price--withoutTax';
                let cachedAmount = '{{product.price.without_tax.value}}';
            {{/if}}
            {{else if page_type '===' 'cart'}}
                let targetSelector = 'ul.cart-totals li.cart-total:last-child';
                let priceSelector = '.cart-total-grandTotal';
                let cachedAmount = '{{cart.grand_total.value}}';
            {{/if}}
                const locales = {
                    AUD: 'en_AU',
                    NZD: 'en_NZ',
                    USD: 'en_US',
                    CAD: 'en_CA',
                };
                const init = function(){
                    Afterpay.createPlacements({
                        targetSelector: targetSelector,
                        attributes: {
                            locale: locales[currency],
                            currency: currency,
                            amount: cachedAmount,
                        }
                    });
                };
                const script = document.createElement('script');
                script.src = "https://js.afterpay.com/afterpay-1.x.js";
                script.dataset.min = "1.00";
                script.dataset.max = "2000.00";
                script.onload = function () {
                    init();
                    setInterval(() => {
                        if (cachedAmount != document.querySelector(priceSelector).innerText) {
                           cachedAmount = document.querySelector(priceSelector).innerText;
                           if (document.querySelector('afterpay-placement')) {
                               document.querySelector('afterpay-placement').dataset.amount = cachedAmount;
                           } else {
                               init();
                           }
                        }
                    }, 400);
                };
                document.head.appendChild(script);
        }
    })();
{{/or}}
</script>
<!-- End Afterpay Stencil Snippet for BigCommerce v3.1.1 -->

You can modify the script so that the banner will only display a price breakdown if the product meets your order minimum and maximum thresholds.

To do so, you will need to edit the following values within the script and set the minimum and maximum values to mirror your Afterpay account settings.
script.dataset.min = "1.00";
script.dataset.max = "800.00";

For example, if you set the script.dataset.max value to 100.00, your shoppers would see the following banner on a 200.00 priced product:

🚧

Banner not showing up?

Sometimes the script may not work because the HTML elements may be named differently depending on your theme. Please work with your developer to help update the script depending on your theme.

Blueprint

  1. Access your themes template files by going to Storefront › Templates Files.
    Find the file Panels/ProductDetails.html.
  2. Copy the script below and paste it in Panels/ProductDetails.html:
<!-- Begin Afterpay Blueprint Snippet for BigCommerce v2.0.1 -->
<afterpay-placement></afterpay-placement>
<script>
    (function(){
        const supported = ["AUD", "NZD", "USD"];
        const currency = '%%GLOBAL_CurrentCurrencyCode%%';
        if (supported.indexOf(currency) > -1) {
            let priceSelector = '.ProductDetailsGrid .VariationProductPrice';
            let cachedAmount = '%%GLOBAL_RawProductPrice%%';
            const locales = {
                AUD: 'en_AU',
                NZD: 'en_NZ',
                USD: 'en_US',
            };
            const placement = document.querySelector('afterpay-placement');
            placement.dataset.locale = locales[currency];
            placement.dataset.currency = currency;
            placement.dataset.amount = cachedAmount;
            const script = document.createElement('script');
            script.src = "https://js.afterpay.com/afterpay-1.x.js";
            script.dataset.min = "1.00";
            script.dataset.max = "2000.00";
            script.onload = function () {
                setInterval(() => {
                    if (cachedAmount != document.querySelector(priceSelector).innerText) {
                       cachedAmount = document.querySelector(priceSelector).innerText;
                       placement.dataset.amount = cachedAmount;
                    }
                }, 400);
            };
            document.head.appendChild(script);
        }
    })();
</script>
<!-- End Afterpay Blueprint Snippet for BigCommerce v2.0.1 -->

You should now see Afterpay's messaging underneath the price of products and the cart total.

Updated over 1 year ago