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 Promotions Standard API

The Promotions Standard API from Elastic Path — 3 operation(s) for promotions standard.

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

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

6 operations 3 paths 34 schemas 1 DELETE3 GET1 POST1 PUT

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 Promotions Standard API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 6

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

Promotions Standard 6
GET
/v2/promotions
Get all Promotions
getAllPromotions 3 params → 200401
POST
/v2/promotions
Create a Promotion
createAPromotion 1 param body → 201401
GET
/v2/promotions/{promotionID}
Get a Promotion
getAPromotion 2 params → 200401
PUT
/v2/promotions/{promotionID}
Update a Promotion
updateAPromotion 2 params body → 200401
DELETE
/v2/promotions/{promotionID}
Delete a Promotion
deleteAPromotion 2 params → 204401
GET
/v2/promotions/{promotionID}/history
Get a Promotion History
getAPromotionHistory 2 params → 200401

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are Data.BasePromotions (11 properties), Response.PageLinks (5 properties), Response.PaginationPage (4 properties), Response.Error (3 properties). Each schema is shown below with its type and property counts.

Data.AttributeObject
object
1 property
Data.FixedBundleDiscountPromotion
Data.XForAmountDiscountPromotion
Data.Promotions.Schema.Gifts
object
2 properties 1 required
Data.Promotions.Schema.TargetNodes
object
1 property
Data.Promotions.Schema.YValue
object
1 property 1 required
Data.Promotions.Schema.PercentageAndCurrencyArray
object
1 property 1 required
Data.Promotions.Schema.Currencies.AmountAndCurrency
object
2 properties 2 required
Data.ItemPercentDiscountPromotion
Data.Promotions.Schema.XValue
object
1 property 1 required
Response.PaginationPage
object
4 properties
Data.ItemFixedDiscountPromotion
Data.Promotions.Schema.Requirement
object
2 properties 2 required
Data.FreeGiftPromotion
Data.Promotions.Schema.AmountAndCurrencyArray
object
1 property 1 required
Data.Promotions.Schema.Currencies.PercentageAndCurrency
object
2 properties 2 required
Response.Error
array
3 properties
Data.BasePromotions
object
11 properties 10 required
Data.Promotions.Schema.Exclude
object
1 property
Data.NodesObject
object
1 property
Data.Promotions.Schema.Percent
object
1 property 1 required
Response.Meta.Promotions
object
2 properties
Data.CartPercentDiscountPromotion
Data.CartFixedDiscountPromotion
Data.Promotions.Schema.TargetAttributes
object
1 property
Response.PaginationResults
object
1 property
Response.Data
object
Specifies the type of the resource. The type of resource for promotions is, promotioncodes.
1 property
Data.Promotions.Schema.Requirements
object
1 property 1 required
Response.PageLinks
object
5 properties
Data.Conditions
object
1 property
Data.Promotions.Schema.TargetCatalogs
object
1 property
Data.XForYDiscountPromotion
Data.Promotions.Schema.Targets
object
1 property
Data.PromotionObject
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-promotions-standard-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