Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.

13 operations 10 paths 59 schemas 1 DELETE8 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
25.1126.6886238
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
License
Resource Areas
1

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 13

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…

POST
/pcm/catalogs/reindex-releases
Reindex all releases for tenant
ReindexTenantReleases body → 200400409500
GET
/v2/jobs
Get All Jobs
getMultipleJobs → 200500
POST
/v2/jobs
Create Job
createJob body → 202500
GET
/v2/jobs/{jobID}
Get a Job
getAJob 1 param → 200404500
GET
/v2/jobs/{jobID}/file
Get a Job File
getAJobFile 1 param → 200404500
GET
/pcm/jobs
Get All Jobs
getAllJobs → 200400404422500
GET
/pcm/jobs/{jobID}
Get a Job
getJob 1 param → 200400404422500
POST
/pcm/jobs/{jobID}/cancel
Cancel a Job
cancelJob 1 param body → 200400404422500
GET
/pcm/jobs/{jobID}/errors
Get Job Errors
getJobErrors 1 param → 200400404422500
POST
/v2/subscriptions/jobs
Create a job
CreateJob 1 param body → 201400409500
GET
/v2/subscriptions/jobs
List jobs
ListJobs 3 params → 200500
GET
/v2/subscriptions/jobs/{job_uuid}
Get job
GetJob 1 param → 200400404500
DELETE
/v2/subscriptions/jobs/{job_uuid}
Delete job
DeleteJob 1 param → 204409

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.

Timestamps
object
The date and time a job is created/updated.
2 properties
SubscriptionJobType
string
Link
JobCreate
object
2 properties 2 required
InvoiceTaxItems
object
2 properties 2 required
Relationship
ImportJobAttributes
object
1 property 1 required
JobAttributes
object
4 properties 2 required
Job_2
object
8 properties
JobResponseAttributes
Relationships
Relationships are established between different subscription entities. For example, a plan and a pricing option are related to an offering, as both are attache…
BillingRunReport
object
5 properties 5 required
RelationshipLinks
object
Links are used to allow you, as an API consumer, to move between requests. Single entities use a self parameter with a link to that specific resource. Sometime…
1 property
JobMeta_2
object
3 properties 2 required
multi_links
object
Links allow you to navigate between pages of results. :::caution Planned pagination changes — on or after 1 September 2026 The pagination behaviour of PIM list…
5 properties
Price
JobAttributes_2
object
2 properties 1 required
SubscriptionUpdateRunJobAttributes
object
5 properties 2 required
TaxRunJobAttributes
object
2 properties 1 required
SubscriptionPriceChanges
object
2 properties
job
object
4 properties 4 required
NotificationRunReport
object
2 properties 2 required
BillingRunJobAttributes
object
1 property 1 required
SubscriptionUpdateReport
object
3 properties 3 required
ExternalRef
string
A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.
single
object
1 property 1 required
TaxItem
object
5 properties 2 required
error
object
1 property 1 required
Error
object
4 properties 2 required
JobMetaResult
object
Result of the job
ErrorResponse
object
1 property 1 required
PaymentRunReport
object
3 properties 3 required
LinkObject
object
3 properties
JobMetaError
object
2 properties 1 required
ReindexTenantReleasesJobRequest
object
1 property
JobCreateAttributes
object
2 properties 1 required
CreateJob
object
1 property
SingleRelationship
object
The subscription resource that is related.
2 properties
JobReport
You can track your Subscriptions billing, tax, and payment operations using reports.
UUID
string
A unique ID generated when a job is created.
LinkURI
string
FileLink
object
A link to the exported data.
1 property
TaxRunReport
object
2 properties 2 required
UUID_2
string
The unique identifier.
errors
object
3 properties 2 required
JobTimestamps
Timestamps_2
object
2 properties 2 required
ManyRelationship
object
The list of resources that are related.
2 properties
Links_2
object
Links
object
Links are used to allow you to move between requests
1 property
Job
object
4 properties 3 required
RelationshipData
object
2 properties 2 required
PricingOptionPrice
object
2 properties
JobMeta
object
Meta information of the job
2 properties
PaymentRunJobAttributes
object
1 property 1 required
Job_3
object
5 properties 3 required
NotificationRunJobAttributes
object
1 property 1 required
OwnerMeta
string
The owner of a resource, either store or organization.
multi
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-jobs-api-openapi.yml Raw ↑

Other APIs Elastic Path publishes across the network.

Elastic Path GraphQL API
Elastic Path Account Addresses API
Elastic Path Account Authentication Settings API
Elastic Path Account Cart Associations API
Elastic Path Account Management Authentication API
Elastic Path Account Members API
Elastic Path Account Membership API
Elastic Path Account Membership Settings API
Elastic Path Account Tags API
Elastic Path Accounts API
Elastic Path Administrator Latest Releases Catalog API API
Elastic Path Application Keys API