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 Rule Promotion Jobs API

The Rule Promotion Jobs API from Elastic Path — 3 operation(s) for rule promotion jobs.

Elastic Path Rule Promotion 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 Rule Promotion Jobs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 3 paths, and defines 7 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.

4 operations 3 paths 7 schemas 2 GET2 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 Rule Promotion Jobs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Rule Promotion Jobs 4
POST
/v2/rule-promotions/{uuid}/jobs
Create a Rule Promotion Job
createRulePromotionJob 1 param body → 201400
GET
/v2/rule-promotions/{uuid}/jobs
Get Rule Promotion Jobs
getRulePromotionJobs 2 params → 200
GET
/v2/rule-promotions/{uuid}/jobs/{job-uuid}/file
Get Rule Promotion Code Exported File
getRulePromotionJobFile 2 params → 200
POST
/v2/rule-promotions/{uuid}/jobs/{job-uuid}/cancel
Cancel a Rule Promotion Job
cancelRulePromotionJob 2 params → 200422

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are PromotionJob (6 properties), PaginationLinks (5 properties), PromotionJobsListResponse (3 properties), PaginationMeta (2 properties). Each schema is shown below with its type and property counts.

PromotionJobsListResponse
object
Successful response
3 properties
PromotionJobResponse
GenerateResult
object
Represents the result of a promotion job, including the number of generated and deleted promotion codes. - generated: Total number of successfully generated co…
2 properties
PromotionJob
object
6 properties
PromotionCodeExportedFileResponse
object
Successful response
1 property
PaginationMeta
object
2 properties
PaginationLinks
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-rule-promotion-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