How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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 Job. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 13 operations across 10 paths, and defines 60 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 5 base URLs: https://euwest.api.elasticpath.com/v2, https://useast.api.elasticpath.com/v2, https://api.moltin.com, https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.

13 operations 10 paths 60 schemas 1 DELETE8 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Elastic Path Jobs API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerToken). It accepts HTTP bearer tokens (bearerAuth).

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.

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 60

The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are Job_2 (8 properties), Error_2 (5 properties), multi_links (5 properties), SubscriptionUpdateRunJobAttributes (5 properties). Each schema is shown below with its type and property counts.

ReindexTenantReleasesJobRequest
object
1 property
ErrorResponse
object
1 property 1 required
JobMetaResult
object
Result of the job
JobMetaError
object
2 properties 1 required
JobAttributes
object
4 properties 2 required
Job
object
4 properties 3 required
JobMeta
object
Meta information of the job
2 properties
Error
object
4 properties 2 required
Links
object
Links are used to allow you to move between requests
1 property
FileLink
object
A link to the exported data.
1 property
UUID
string
A unique ID generated when a job is created.
Error_2
object
5 properties 2 required
CreateJob
object
1 property
Job_2
object
8 properties
Timestamps
object
The date and time a job is created/updated.
2 properties
multi
object
3 properties 2 required
errors
object
3 properties 2 required
job
object
4 properties 4 required
single
object
1 property 1 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
error
object
1 property 1 required
UUID_2
string
The unique identifier.
SubscriptionUpdateReport
object
3 properties 3 required
SubscriptionUpdateRunJobAttributes
object
5 properties 2 required
PricingOptionPrice
object
2 properties
NotificationRunReport
object
2 properties 2 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.
SubscriptionJobType
string
Job_3
object
5 properties 3 required
JobResponseAttributes
Links_2
object
JobReport
You can track your Subscriptions billing, tax, and payment operations using reports.
TaxRunJobAttributes
object
2 properties 1 required
Price
SingleRelationship
object
The subscription resource that is related.
2 properties
JobTimestamps
Relationship
RelationshipData
object
2 properties 2 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
JobCreate
object
2 properties 2 required
JobMeta_2
object
3 properties 2 required
OwnerMeta
string
The owner of a resource, either store or organization.
LinkObject
object
3 properties
TaxItem
object
5 properties 2 required
NotificationRunJobAttributes
object
1 property 1 required
LinkURI
stringnull
JobAttributes_2
object
2 properties 1 required
PaymentRunReport
object
3 properties 3 required
JobCreateAttributes
object
2 properties 1 required
ImportJobAttributes
object
1 property 1 required
SubscriptionPriceChanges
object
2 properties
Timestamps_2
object
2 properties 2 required
Link
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…
PaymentRunJobAttributes
object
1 property 1 required
BillingRunJobAttributes
object
1 property 1 required
TaxRunReport
object
2 properties 2 required
ManyRelationship
object
The list of resources that are related.
2 properties
BillingRunReport
object
5 properties 5 required
InvoiceTaxItems
object
2 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
Elastic Path Application Keys API
Where this information came from

This is an independent, third-party profile of Elastic Path Jobs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.