BigCommerce

Inclusify installs on BigCommerce as one Script Manager entry, placed in the Footer and scoped to All Pages. BigCommerce describes Script Manager as living in the channel settings for the storefront, so you need a control panel user with access to that channel and no particular plan, and it renders through the theme’s {{footer.scripts}} placeholder rather than through any theme file you edit. One form, one Save, and about twenty seconds: BigCommerce states that on a BigCommerce-hosted storefront, new or updated scripts take 20 seconds to cache. Legacy Blueprint stores are the exception, because Script Manager does not render there at all.

Register the domain first

Add your domain in the Inclusify panel before you paste the script tag. Bundles are built per registered domain, and an unregistered one fails silently: the script URL still returns HTTP 200, but what it serves is a single console.log saying the domain is not registered. There is no error to find and no widget appears.

Installation Steps

1

Open Script Manager

In your BigCommerce admin, go to Storefront Script Manager. BigCommerce places Script Manager in the channel settings for a storefront, so if you run more than one storefront channel, open the one you want the widget on.

2

Create Script

Click Create a Script.

3

Configure Script

  • • Name: Inclusify Widget
  • • Location on page: Footer. BigCommerce’s only two locations are head and footer, and footer is what the theme renders through {{footer.scripts}}.
  • • Select pages where script will be added: All Pages. This is the choice that matters: BigCommerce defines the storefront scope as every page that is not checkout or order confirmation, so All Pages is what puts the widget on checkout and My Account too.
  • • Script category: pick the consent category that matches your own policy, from Essential, Functional, Analytics or Targeting. Do not leave it unset. BigCommerce defaults an unspecified category to unknown, and states that scripts with an unknown consent category do not display on stores with customer cookie consent banners enabled.
  • • Script type: Script
  • • Leave the Subresource Integrity field empty. See the notes below.
4

Add Script Content

Paste the widget code in the script content area:

HTML
<script src="https://app.inclusifyapp.com/w/YOUR-DOMAIN.com.js" async></script>

Replace YOUR-DOMAIN.com with your actual domain.

5

Save

Click Save, then wait about twenty seconds before testing. Script Manager injects the tag server-side, and BigCommerce caches new and updated scripts on hosted storefronts for 20 seconds before they appear.

Notes

  • • Script Manager is per storefront channel, so a store with several channels needs the entry in each one
  • • BigCommerce states that its legacy Blueprint theme engine does not render scripts inserted through Script Manager or the Scripts API. Blueprint stores need the tag in the theme’s own template files, and there is no control-panel route
  • • Do not attach a Subresource Integrity hash. BigCommerce warns that a hash becomes invalid when a script’s contents change and the script then fails to execute, and this bundle is generated from your stored widget settings, so its contents change whenever you change the colour, position or language
  • • Scripts added outside the theme do not render under Stencil CLI local development, so verify on the hosted storefront rather than locally
  • • On Catalyst storefronts BigCommerce loads scripts through next/script and warns that client-side navigation means a script is not guaranteed to fire on every navigation. That is fine here: the widget mounts once onto the document and stays

What needs attention on BigCommerce

The two page scopes differ in exactly two places

BigCommerce documents all_pages as covering cart, category, product, search, blog, 404, plus Checkout, My Account, Order Confirmation and Payment Methods, and storefront as the same list with Checkout and My Account removed. So the choice between them is not a performance decision, it is whether the widget is present while a customer checks out.

Script Manager lives in the channel, not the store

BigCommerce describes Script Manager as available in the channel settings for the subject storefront. A store with more than one storefront channel therefore has more than one Script Manager, and adding the tag to one does not add it to the others.

Blueprint stores have no Script Manager at all

BigCommerce is explicit that its legacy theme engine, Blueprint, does not support rendering scripts inserted using the Scripts API or Script Manager. On a Blueprint store the tag has to go into the theme's own template files, and there is no supported control-panel route.

Do not attach a Subresource Integrity hash to the widget

Script Manager can hold SRI hashes, and BigCommerce warns that a hash becomes invalid when the contents of a script change and the script then fails to execute. The widget bundle is generated per domain from your stored settings, so its contents change whenever you change the widget's colour, position or language. An SRI hash would pin it to one configuration and break on the next save.

Catalyst storefronts are a Next.js app

On Catalyst, BigCommerce loads scripts through next/script and warns that client-side navigation means a script is not guaranteed to fire on every page navigation. That is fine here: the widget mounts its button and panel onto the document once and keeps them there across client-side navigation, so it does not need to run again on each route.

Verify the installation

  1. Wait about twenty seconds before testing. BigCommerce states that on a BigCommerce-hosted storefront, new or updated scripts take 20 seconds to cache.
  2. Test on the hosted storefront rather than a local theme. BigCommerce states that scripts added through the Scripts API do not render while you develop a theme locally with Stencil CLI, and Script Manager entries are the same mechanism.
  3. In Script Manager, confirm the entry is listed for the right storefront channel and that its page scope is the one you intended.
  4. Load a category page and a product page as well as the home page.
  5. If you need it on checkout, confirm the scope is All pages rather than Storefront pages: BigCommerce's storefront scope excludes Checkout and My Account, while all pages includes both.

Widget bundles are served from a CDN and cached for a few hours. If you changed widget settings in the panel and the site still shows the old configuration, wait for the cache to expire or load the script URL directly with a cache-busting query string (`?v=2`) to confirm the new version is being served.

Troubleshooting BigCommerce installs

The script is saved but missing from the page a moment later.
Give it twenty seconds. BigCommerce caches new and updated scripts on hosted storefronts for that long before they appear.
The script does not run on checkout.
The page scope is Storefront pages, which BigCommerce defines as excluding Checkout and My Account. Change it to All pages, which includes both.
Nothing appears on a Blueprint theme.
Blueprint does not render Script Manager or Scripts API scripts at all. Add the tag to the theme's template files through the theme file editor, or migrate the storefront to Stencil.
The widget is missing while developing the theme locally.
That is expected. Scripts added outside the theme do not render under Stencil CLI local development. Test on the hosted storefront instead.
The script stopped executing after a widget settings change.
An SRI hash is attached to the entry. The bundle is generated from your stored settings, so its contents change when the settings do, and BigCommerce fails a script whose hash no longer matches. Remove the hash.
The widget shows on one storefront but not another.
Script Manager is per channel. Add the entry in each storefront channel's settings.

BigCommerce questions

Do I need to edit theme files?
No, not on Stencil: Script Manager is the supported path, it lives in the channel rather than the theme, and it survives theme updates. Blueprint stores are the exception, because BigCommerce does not render Script Manager scripts there at all.
Which themes are supported?
All Stencil themes, plus headless and Catalyst storefronts. Blueprint is legacy and does not support Script Manager or the Scripts API, so those stores need the tag in the theme's own files.
Where should the script be placed?
Footer, on All Pages. BigCommerce renders footer scripts through the theme's {{footer.scripts}} placeholder, the tag is async so it needs no head placement, and All Pages is the scope that includes checkout.
Will it survive a theme change?
Yes on Stencil. Script Manager entries belong to the storefront channel rather than the theme, so switching or updating a theme leaves them in place.
Should I add a Subresource Integrity hash?
No. The bundle is built per domain from your stored widget settings, so its contents change whenever you change those settings, and BigCommerce fails a script whose SRI hash no longer matches its contents.

BigCommerce documentation

Every BigCommerce-specific requirement, menu path and limit on this page comes from these pages. Menus move, so check them against your own admin if something does not match.

Related