Setup
Use this guide to prepare a store for IntentFlow autocomplete.
Requirements
| Requirement | Notes |
|---|---|
| Storefront domain | Example: shop.example.com. |
| Product catalog | CSV import or supported platform integration. |
| Store API key | Generated in the IntentFlow dashboard and shown once. |
| Theme access | Needed to place the widget script near the search input. |
1. Create a store
- Sign in to the IntentFlow dashboard.
- Open the store list.
- Create a store with name, domain, language, and currency.
- Confirm the store appears in the dashboard.
TODO: Add screenshots for the create-store form and the store overview page.
2. Add products
Choose one product source:
| Source | Best for | Status |
|---|---|---|
| CSV upload | Quick setup, early migrations, custom catalogs | Available |
| Shopify | Shopify storefronts | PLACEHOLDER |
| WooCommerce | WordPress/WooCommerce storefronts | PLACEHOLDER |
| Magento, BigCommerce, PrestaShop, Drupal Commerce | Platform integrations | PLACEHOLDER |
| Custom API | Direct backend integration | PLACEHOLDER |
See Product Index for the catalog requirements.
3. Generate an API key
- Open the store API keys page.
- Create a key with a recognizable name such as
Production widget. - Copy the key when it is shown.
- Store it securely for widget placement.
The plain key is shown once. If it is lost, rotate the key and update the widget snippet.
4. Install the widget
Add the widget script to the storefront page or layout that contains the search input.
html
<script
src="https://app.example.com/widget.js"
data-store-id="STORE_UUID"
data-api-key="if_PLACEHOLDER_KEY">
</script>See Widget Placement for configuration options.
5. Test search
- Open the storefront page that contains the search input.
- Type at least two characters.
- Confirm suggestions and products appear.
- Select a suggestion and confirm it fills the input.
- Select a product and confirm it opens the product URL.
Troubleshooting checklist
| Symptom | Check |
|---|---|
| No dropdown appears | Confirm the widget script loads and the page has a matching search input. |
Requests return 401 | Confirm the API key is active and copied correctly. |
Requests return 422 | Confirm the query and limit values are valid. |
| Products are missing | Confirm the catalog import completed and products are in stock if expected. |
| Styling looks wrong | Confirm the widget Shadow DOM is mounted and host page scripts are not removing it. |