# Elastic Path Jobs API

**Canonical:** https://apis.io/apis/elastic-path/elastic-path-jobs-api/  
**Provider:** Elastic Path — https://apis.io/providers/elastic-path/  
**Base URL:** https://useast.api.elasticpath.com  
**Documentation:** https://developer.elasticpath.com/api

Elastic Path Jobs API is one of 100 APIs that [Elastic Path](https://apis.io/providers/elastic-path/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Job. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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.

## Machine-readable artifacts (2)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/elastic-path/refs/heads/main/openapi/elastic-path-jobs-api-openapi.yml
- **Documentation** — https://developer.elasticpath.com/api

## Other Elastic Path APIs (12)

- [Elastic Path GraphQL API](https://apis.io/apis/elastic-path/graphql-api/)
- [Elastic Path Account Addresses API](https://apis.io/apis/elastic-path/elastic-path-account-addresses-api/)
- [Elastic Path Account Authentication Settings API](https://apis.io/apis/elastic-path/elastic-path-account-authentication-settings-api/)
- [Elastic Path Account Cart Associations API](https://apis.io/apis/elastic-path/elastic-path-account-cart-associations-api/)
- [Elastic Path Account Management Authentication API](https://apis.io/apis/elastic-path/elastic-path-account-management-authentication-api/)
- [Elastic Path Account Members API](https://apis.io/apis/elastic-path/elastic-path-account-members-api/)
- [Elastic Path Account Membership API](https://apis.io/apis/elastic-path/elastic-path-account-membership-api/)
- [Elastic Path Account Membership Settings API](https://apis.io/apis/elastic-path/elastic-path-account-membership-settings-api/)
- [Elastic Path Account Tags API](https://apis.io/apis/elastic-path/elastic-path-account-tags-api/)
- [Elastic Path Accounts API](https://apis.io/apis/elastic-path/elastic-path-accounts-api/)
- [Elastic Path Administrator Latest Releases Catalog API API](https://apis.io/apis/elastic-path/elastic-path-administrator-latest-releases-catalog-api-api/)
- [Elastic Path Application Keys API](https://apis.io/apis/elastic-path/elastic-path-application-keys-api/)

## Tags

Job

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/elastic-path/elastic-path-jobs-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/elastic-path/.
