JavaScript API

FilterIQ does not currently publish a generally available JavaScript SDK. The Theme App Extension is the supported storefront integration. FilterIQ is in private preview; request access before planning an installation.

Use the Theme App Extension

For an accepted preview store:

1. Follow the installation path supplied by the team and review the permissions shown by Shopify.
2. Create a duplicate theme and record the current search, filter and other app settings.
3. Enable the supplied app embed or blocks on the duplicate theme using the Theme App Extension guide.
4. Review filter configuration and test search terms, empty results, sorting, pagination and mobile interactions in that theme's preview.
5. Confirm which configuration changes affect the whole store before publishing. Retain the previous theme and settings as a rollback path.

The extension manages its own configuration and requests. Internal globals, script filenames and observed browser requests are implementation details, not a JavaScript interface that custom code can depend on.

Headless and Custom Storefronts

A Hydrogen or custom React storefront does not become integrated by enabling a Shopify theme embed. Before committing engineering time, contact the team with your framework, hosting arrangement, required search and filter behaviour, catalogue size, product fields and published store languages.

Ask the team to confirm authentication, limits, versioning and support in writing. An agreed interface should explain response schemas, empty/error states, rate limiting and consumer updates. App access does not establish that such an interface is available.

Validate Before Publishing

Test representative queries and filter combinations, including unavailable products, restrictive combinations and locale-specific vocabulary. Check keyboard focus, loading states and recovery when a request fails. Record expected results and compare them after configuration changes.

Do not copy internal extension calls into production as a substitute for an agreed contract. The REST integration boundary explains why internal admin and service routes are not a public API reference.