Searchable Fields
The Searchable Fields API returns a list of all fields available for searching, filtering, faceting, and sorting in your search queries. This includes both the standard product fields that are indexed by default and any custom fields you've added through Indexable Fields.
Using Searchable Fields
Use this endpoint to:
- Discover available fields: See all fields that can be used in search queries
- Build dynamic UIs: Programmatically generate filter and facet options based on available fields
- Validate configurations: Verify that your indexable fields have been properly added to the schema
Field Properties
Each searchable field includes:
| Property | Description |
|---|---|
name | The field name to use in search queries |
type | The data type (string, int32, int64, float, bool) |
facetable | Whether the field can be used for faceting |
sortable | Whether the field can be used for sorting |
locale | The language code for text fields |
Standard vs Custom Fields
- Standard fields: Built-in fields like
name,description,sku,meta.search.nodes.namethat are always available - Custom fields: Fields added through Indexable Fields from your product extensions
📄️ List searchable fields
List searchable fields.