Skip to content
New Webhooks added: Inventory and Order modifications. Check the changelog →
Cartly Developers

Storefront Faceted Filtering

Typesense-backed faceted filters on collection pages. Auto-detected from product data with merchant-configurable overrides.

Overview

Faceted filtering is built into every Cartly collection page and powered by Typesense. Filters appear automatically from product data — no theme changes required. Merchants configure overrides from Admin → Settings → Storefront Filters.

Built-in filter types

FilterURL param prefixNotes
Variant optionfilter.v.option.<key>Case-insensitive. Auto-detected from variant data.
Product tagfilter.v.tagMulti-value AND logic.
Vendorfilter.v.vendorShown when data exists.
Availabilityfilter.v.availabilitytrue = in-stock only.
Price rangefilter.v.price.gte / .lteValues in cents (int64).
Product metafieldfilter.v.p.metafields.<ns>.<key>Requires storefront_filterable=true on definition.

URL parameter scheme

bash
/collections/t-shirts?filter.v.option.color=Red&filter.v.tag=new&filter.v.price.gte=2000&sort_by=price-ascending

API Reference

MethodPathDescription
GET/admin/storefront-filtersList overrides
GET/admin/storefront-filters/available-sourcesAll filter sources (built-ins + options + filterable metafields)
POST/admin/storefront-filtersCreate override
PUT/admin/storefront-filters/:idUpdate override
DELETE/admin/storefront-filters/:idDelete override
PUT/admin/storefront-filters/reorderBulk reorder (max 200 positions)
POST/admin/storefront-filters/reindexTrigger full-shop Typesense reindex
GET/admin/storefront-filters/reindex-statusPoll reindex progress

All endpoints require a valid admin JWT. State-changing endpoints require X-Idempotency-Key header.

Full Storefront Faceted Filtering guide →