REST API Reference
Public API availability and authentication boundaries for custom FilterIQ integrations.
REST API Reference
FilterIQ's storefront extension and authenticated admin application use service routes internally. These routes are implementation details and are not a supported public API. A backend-generated OpenAPI document or an endpoint observed in browser tools does not establish a released external contract.
FilterIQ is in private preview. Request access or contact the team for current integration options before building a custom client.
Supported Storefront Path
Use the Theme App Extension for the supported Shopify storefront integration. The extension issues its own requests through the configured Shopify app proxy. Follow the installation and duplicate-theme validation steps in that guide.
Merchant configuration is managed through the authenticated FilterIQ application in Shopify admin. Its internal service calls are not intended to be replayed by an external client.
Identity and Authentication Boundaries
Shop identity comes from verified Shopify authentication context. A caller-provided shop name in a body, query parameter or arbitrary header is not proof of permission to access that shop.
Storefront proxy verification and authenticated admin sessions are different boundaries. Do not reuse internal service credentials or admin session material in storefront JavaScript. A custom integration needs an explicitly supported authentication flow with defined permissions and tenant isolation.
What to Confirm for a Custom Integration
Request a written interface contract covering:
| Contract area | Details to confirm |
|---|---|
| Availability | Supported architecture, access eligibility and test environment |
| Authentication | Verified identity, scopes, credential handling and allowed operations |
| Requests and responses | Versioned schemas, validation, pagination and empty/error states |
| Limits | Rate limits, catalogue coverage, timeouts and retry behaviour |
| Changes | Versioning, compatibility period and deprecation process |
| Operations | Support arrangements, observability and rollback |
This page does not supply endpoint paths or executable examples because no generally available external API contract has been established. The JavaScript availability guide covers browser and headless clients.
Test the Agreed Interface
If the team confirms a supported custom interface, validate it in the agreed test environment. Check valid and invalid authentication, query/filter validation, empty results, timeout/error recovery and any write operations separately.
Keep the accepted contract and test results with the integration. A successful request to an internal route is not evidence that it is supported or stable for external use.