Elastic Path Jobs API
Jobs manage the indexing operations for catalog search. When catalogs are published or when reindexing is required, jobs process the product data and build search indexes. ### Job Types | Type | Description | |---------------------------|-----------------------------------------------------------------------------------------------------| | `index-release` | Index a specific catalog release. Created automatically when a search-enabled catalog is published. | | `delete-release` | Remove the search index for a catalog release. | | `reindex-tenant-releases` | Reindex all catalog releases for the store. Use when indexable fields have changed. | ### Job Lifecycle Jobs progress through the following states: 1. **pending**: Job has been created and is waiting to be processed 2. **processing**: Job is actively indexing products 3. **complete**: Job finished successfully 4. **failed**: Job encountered an error ### Automatic Indexing When you publish a catalog with search enabled, an `index-release` job is automatically created. The catalog release remains in a publishing state until the indexing job completes successfully. ### Manual Reindexing Use the reindex endpoint when: - You've added, modified, or deleted indexable fields - Search indexes are out of sync (check via [Search Indexes](/docs/api/pxm/catalog-search/search-indexes)) - You need to rebuild indexes after a failure The reindex operation creates jobs for all catalog releases that need updating. You can optionally force a full reindex of all releases regardless of their sync status. ### Conflict Handling Only one reindexing operation can run at a time. If you attempt to start a reindex while another is in progress, the API returns a 409 Conflict error.