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 LifecycleJobs progress through the following states:1. **pending**: Job has been created and is waiting to be processed2. **processing**: Job is actively indexing products3. **complete**: Job finished successfully4. **failed**: Job encountered an error### Automatic IndexingWhen 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 ReindexingUse 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 failureThe 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 HandlingOnly 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.
Elastic Path Jobs API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Jobs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 13 operations across 10 paths, and defines 59 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.
Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Elastic Path Jobs API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerToken).
By default, every request must be authenticated.
Paths & Operations 13
Across 10 paths, the API surfaces 13 operations — 1 DELETE, 8 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.
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 Typ…
Schemas 59
The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are Job_2 (8 properties), TaxItem (5 properties), BillingRunReport (5 properties), Job_3 (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elastic Path 12
Other APIs Elastic Path publishes across the network.