# Elastic Path Promotion Jobs API

**Canonical:** https://apis.io/apis/elastic-path/elastic-path-promotion-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 Promotion 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 Promotion Jobs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

Use Jobs API to initiate a job within a promotion. Jobs operate asynchronously and have a different status based on their progress. The following are the job statuses: - `pending`: Commerce has received the request but is currently busy processing other requests. - `processing`: Commerce has initiated processing the job. - `completed`: The job is successfully completed. - `failed`: The job has failed. - `cancelling`: The job is currently in the process of being canceled. You need to wait for the cancellation process to complete. This occurs prior to the `cancelled` status. For example, if you cancel a big `code_generate` job, it may take some time for the cancellation to complete since part of the cancellation process involves deleting the generated codes. - `cancelled` : The job request is canceled. ![Promotion Job Statuses Workflow](/assets/job_status_workflow.png) ### Characteristics of Jobs - You can only initiate one job at a time within a promotion. If you want to run another job for the same promotion, you must wait until the previous job is `completed` or `failed`. However, you can create new jobs for different promotions even if there are `pending` jobs in other promotions. - If you intend to manage promotions with more than 10,000 codes per promotion, we recommend [exporting codes](/docs/api/promotions/create-a-promotion-job) for viewing purposes instead of attempting to view them within Commerce Manager. This recommendation is made due to our enforced maximum page offset limit of 10,000. Altering the page_offset_limit value poses potential performance risks to the platform. - A `code_generate` job is initiated even if the maximum allowable number of codes for the promotion has been reached. However, when processed, this job will fail. To view the status of this failed job, you can only do so by passing [GET Jobs](/docs/api/promotions/get-promotion-jobs) request. - A limited number of jobs can be processed at a time. Jobs are queued and processed sequentially, one after the other. You can expect a certain delay before job processing.

## Machine-readable artifacts (2)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/elastic-path/refs/heads/main/openapi/elastic-path-promotion-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

Promotion Jobs

---

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