Getting Started

1. Install the app

Install XSearch on your BigCommerce store. The install asks for three permissions: product read/write, store information (read), and channel settings (read). After OAuth completes, the admin opens inside your BigCommerce control panel.

2. Complete the launch checklist

Open the Dashboard and follow the Storefront launch checklist. Start Sync catalog when prompted. XSearch pulls your full catalog — products, variants, custom fields, categories, brands and channel assignments — and builds your search index. Progress is shown live; large catalogs index in batches.

3. Configure your schema

The Search Schema page lists every field found in your catalog. Choose which fields are facets, their widget type (checkbox, multiselect, swatch, range, category tree) and their order. Changes to facet selection apply immediately; changes to field types require a reindex (the UI tells you when).

4. Preview

Storefront Preview renders your live search experience — the same API your storefront uses, so preview and production can never drift.

5. Connect a Stencil storefront

Open Settings → Storefront API, enable the public endpoint, and confirm your storefront URL is in the allowed origins. Then open Settings → Storefront Script, enable the intended Stencil channel, and copy its snippet.

In BigCommerce, open Storefront → Script Manager → Create a Script. Set the placement to Footer, location to All pages, and type to Script. Paste the snippet and save. XSearch does not edit theme files.

Visit a category or search-results page to verify the product grid. Add ?xsearch=off to the storefront URL at any time to compare the native theme listing or troubleshoot delivery.

6. Connect a headless storefront

Catalyst and other headless storefronts call the public search API with the store hash and channel ID. Add the storefront origin under Settings → Storefront API, then see the Catalyst integration guide for the client setup.