Search Indexes
Search Indexes represent the indexed data for your catalog releases. Each time a catalog is published with search enabled, a search index is created containing the product data optimized for fast querying.
Index Status
The Search Indexes API allows you to view the status of your indexes and identify any that are out of sync. An index becomes out of sync when:
- Indexable fields have been added, modified, or deleted
- The index failed to build during catalog publishing
- A reindex is required due to schema changes
Monitoring Indexes
Use the list endpoint to:
- View all indexes: See all search indexes for your store
- Check sync status: Identify indexes that need reindexing
- Filter by status: Find only out-of-sync indexes using the
out_of_syncquery parameter
Index Information
Each search index includes:
| Property | Description |
|---|---|
catalog_id | The ID of the catalog this index belongs to |
release_id | The ID of the catalog release this index was built from |
out_of_sync | Whether the index needs to be rebuilt |
Reindexing
When indexes are out of sync, use the reindex endpoint in Jobs to rebuild them. Reindexing ensures your search indexes reflect the current indexable field configuration.
📄️ List search indexes
List search indexes.