👎

Set Up Bolt for BigCommerce

Prerequisites

You must have an approved Bolt account before installing Bolt Checkout to your store. Sign up for a free account.


1. Add a Bolt User to BigCommerce

  1. Log in to BigCommerce.
  2. Navigate to Settings or Account Settings > Users.
  3. Select Create a User Account.
  4. Add dev@bolt.com as a user by completing the following fields:
    • Email: dev@bolt.com
    • Status: Active
    • User Role: Sales Manager
    • System Admin Permissions: (enable the following)
      • Manage Settings
      • Manage Payments
      • Store Design
      • Design Mode
      • Store Logs
    • Enable WebDav: Yes
  5. Save.

BigCommerce automatically sends dev@bolt.me an email to activate the login.

2. Install Plugin

  1. Navigate to Bolt’s page in the BigCommerce eCommerce Apps Marketplace.
  2. Select Get This App.
  3. Select Install > Confirm.

3. Add Webhook Endpoints in Merchant Dashboard

  1. Login to the Bolt Production Merchant Dashboard and Sandbox Merchant Dashboard.
  2. Navigate to Developer > Webhooks.
  3. Scroll to Webhook Endpoints.
  4. Verify the Webhook URL has populated automatically.

Don’t see a Webhook URL? Try to re-install the plugin — if that doesn’t work, please contact Bolt for assistance.

4. Add Bolt as Payment Method in BigCommerce

  1. Log in to the Bolt Merchant Dashboard.
  2. Navigate to Developer > API > Keys.
  3. Copy the following keys:
    • API Key
    • Signing Secret
    • Publishable Key
  4. In a new tab, Log in to BigCommerce.
  5. Navigate to Store Setup > Payments.
  6. Scroll to Online Payment Methods > Bolt.
  7. Select Setup.
  8. Paste your keys into the required fields.
  9. Save.

For Legacy Migrations: Remember to check your theme files and remove/update any references to your previous API keys. For assistance with this step, reach out to your Customer Success Manager.

5. Choose a Bolt Product

There are two main product options available for merchant using Bolt’s BigCommerce plugin: Full Bolt Checkout with Fraud Protection and Bolt Fraud Protection.

  1. Log in to BigCommerce.
  2. Navigate to Store Setup > Payments.
  3. Scroll to Online Payment Methods > Bolt.
  4. Select Bolt Settings.
  5. Update Configuration Mode to your-product-choice.
  6. Save.

For manual captures, set the Manual Orders Transaction Type to Authorize Only.

6. Add Scripts & Buttons

Bolt relies on a few scripts to deliver its checkout and SSO Commerce experience to your shoppers: account.js, connect.js, and tracking.js. For this step, you must add Bolt’s scripts and buttons to every page where the cart is displayed in your storefront. This requires a few theme updates. Typically, these updates happen to the following files:

  • templates > components > cart > preview.html
  • templates > components > cart > totals.html
  • templates > components > common > cart-preview.html
  • templates > components > products > add-to-cart.html
  • templates > pages > cart.html

Navigate to Store Front > My Themes > Advanced > Edit Theme Files to view these files. We recommend copying your theme before making any changes.

Add Scripts

  1. Log in to BigCommerce.
  2. Navigate to your theme files.
  3. Add the following scripts to both your sandbox and production environments (above the first div tag):

insert scripts here

Production Scripts

<!--Get your PUBLISHABLE_KEY from the Bolt Merchant Dashboard.-->
<script
  id="bolt-connect"
  type="text/javascript"
  src="https://connect.bolt.com/connect-bigcommerce.js"
  data-publishable-key="{PUBLISHABLE_KEY}"
  data-storefront-api-token="{{settings.storefront_api.token}}"
  route-public-token="{ROUTE_PUBLIC_TOKEN}">
</script>
<!-- This script automatically updates the Bolt cart when an item is added in the cart page.-->
<script>
var config = { childList: true, subtree: true };
var totalClassName = "previewCartCheckout-price";
var totalPrice = "";
var callback = function(mutationsList) {
    var elms = document.getElementsByClassName(totalClassName);
    if (elms.length == 0) {
        return;
    }
    var newPrice = elms[0].innerHTML;
    if (newPrice !== totalPrice && window.BoltCheckout) {
        window.BoltCheckout.reloadBigCommerceCart();
    }
    totalPrice = newPrice;
};
new MutationObserver(callback).observe(document.body, config);
</script>

Sandbox Scripts

<!--Get your PUBLISHABLE_KEY from the Bolt Merchant Dashboard.-->
<script
  id="bolt-connect"
  type="text/javascript"
  src="https://connect-sandbox.bolt.com/connect-bigcommerce.js"
  data-publishable-key="{PUBLISHABLE_KEY}"
  data-storefront-api-token="{{settings.storefront_api.token}}"
  route-public-token="{ROUTE_PUBLIC_TOKEN}">
</script>
<!-- This script automatically updates the Bolt cart when an item is added in the cart page.-->
<script>
var config = { childList: true, subtree: true };
var totalClassName = "previewCartCheckout-price";
var totalPrice = "";
var callback = function(mutationsList) {
    var elms = document.getElementsByClassName(totalClassName);
    if (elms.length == 0) {
        return;
    }
    var newPrice = elms[0].innerHTML;
    if (newPrice !== totalPrice && window.BoltCheckout) {
        window.BoltCheckout.reloadBigCommerceCart();
    }
    totalPrice = newPrice;
};
new MutationObserver(callback).observe(document.body, config);
</script>
  1. Replace the PUBLISHABLE_KEY.
  2. Replace the ROUTE_PUBLIC_TOKEN if you are using Route shipping insurance or remove the line from the script.

Add Buttons

  1. Log in to BigCommerce.
  2. Navigate to your theme files.
  3. Add the following to both your production and sandbox environments in the same places where your original checkout button can be found.

Production

<div data-tid="instant-bolt-checkout-button">
<object data="https://connect.bolt.com/v1/checkout_button?publishable_key=PUBLISHABLE_KEY">
</object>
</div>

Sandbox

<div data-tid="instant-bolt-checkout-button">
<object data="https://connect-sandbox.bolt.com/v1/checkout_button?publishable_key=PUBLISHABLE_KEY">
</object>
</div>
  1. Replace PUBLISHABLE_KEY with your publishable key found in the Bolt Merchant Dashboard.
  2. Add the following script to hide the original checkout button to prevent it from displaying.

The original checkout button’s name may vary depending on your existing theme. Make sure the correct button is named in the querySelector to properly hide it.

<script>
        var originalCheckoutButton = document.querySelector(".cart-actions .button--primary");
        var boltButtons = document.getElementsByClassName("bolt-button-wrapper");
        for (var i = 0; i < boltButtons.length; i++) {
            boltButtons[i].style.display = 'block';
        }
        originalCheckoutButton.style.display = 'none';
    </script>
📖 On This Page