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

The Rule Promotions API from Elastic Path — 2 operation(s) for rule promotions.

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

This API exposes 5 operations across 2 paths, and defines 45 schemas. It is described by OpenAPI 3.2.0, at version 26.0504.7552059.

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

5 operations 2 paths 45 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Elastic Path Rule Promotions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

Paths & Operations 5

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

Rule Promotions 5
POST
/v2/rule-promotions
Create a Rule Promotion
createRulePromotion 1 param body → 201400422
GET
/v2/rule-promotions
Get Rule Promotions
getRulePromotions 4 params → 200400
GET
/v2/rule-promotions/{promotionID}
Get a Rule Promotion by ID
getRulePromotionById 2 params → 200404
PUT
/v2/rule-promotions/{promotionID}
Update a Rule Promotion
updateRulePromotion 2 params body → 200400422
DELETE
/v2/rule-promotions/{promotionID}
Delete a Rule Promotion
deleteRulePromotion 2 params → 204

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are RulePromotionBaseAttributes (15 properties), PaginationLinks (5 properties), ItemIdentifier (4 properties), ItemCategory (4 properties). Each schema is shown below with its type and property counts.

ItemCategory
object
4 properties
ItemsBundle
object
2 properties
ItemSku
object
3 properties
CartTotal
object
3 properties
PercentArg
array
Apply a percentage based discount to the amount.
ItemPrice
object
4 properties
RulePromotionListResponse
object
3 properties
BaseCondition
object
Specifies which items should be included or excluded when applying the discount. Can be based on factors such as item SKUs, product attributes, quantities, or…
4 properties
ItemProductId
object
3 properties
PaginationLinks
object
5 properties
CartDiscount
object
4 properties
Or
object
2 properties
FixedPriceQuantityArg
array
Set the amount to this fixed value.
CartTotalArg
array
ItemQuantityCondition
object
Quantity-based condition for targeting items based on their cart quantity. Useful for bulk discount requirements or minimum quantity thresholds.
3 properties
AccountTags
object
3 properties
CartCustomAttributes
object
3 properties
CartItemCustomAttributeCondition
object
Custom attribute-based condition for targeting cart items by their custom attributes. Allows complex filtering based on item-level custom metadata.
3 properties
ItemAttributeCondition
object
Attribute-based condition for targeting items by their custom attributes. Allows complex filtering based on product metadata and characteristics.
3 properties
PaginationMeta
object
2 properties
CartTotalCondition
object
Cart total condition for gating a cartdiscount action. The action is applied only when the cart total (or the total of a filtered subset of items) meets the th…
4 properties 3 required
CartTotalRangeArg
array
AndCondition
object
Logical AND condition requiring ALL child conditions to be satisfied. Only valid at the top level of an action condition. Children must all be the same level —…
2 properties
ItemDiscount
object
4 properties
ShippingTypeCondition
object
Shipping type condition for targeting discounts based on shipping method. Only supported in shipping discount actions.
3 properties
RulePromotionResponse
object
1 property
ItemIdentifierCondition
object
Identifies specific items by SKU or Product ID for targeted discounting. This is the recommended approach for precise item targeting in action conditions.
4 properties
RulePromotionItem
ShippingDiscount
object
3 properties
RulePromotionBaseAttributes
object
15 properties
OrCondition
object
Logical OR condition requiring ANY child condition to be satisfied. Only valid at the top level of a cartdiscount action condition. The primary use case is com…
2 properties
And
object
2 properties
ItemPriceCondition
object
Price-based condition for targeting items based on their unit price. Allows filtering by price ranges using comparison operators.
3 properties
ItemQuantity
object
3 properties
BundleDiscount
object
4 properties
RulePromotionBaseRuleSetBaseAttributes
object
1 property
FixedArg
array
Apply a fixed discount to the amount.
Response.Error
object
1 property
FixedPriceArg
array
Set the amount to this fixed value.
Condition
object
The condition that gates this action. When present, the action is applied only if the condition is satisfied. Valid top-level strategies: - carttotal — gates t…
ItemsBundleCondition
object
Bundle condition for targeting specific item combinations. Only supported in items bundle discount actions for defining required item groups.
2 properties
ItemIdentifier
object
4 properties
ItemAttribute
object
4 properties
ItemCategoryCondition
object
Category-based condition for targeting items by their category breadcrumbs (i.e., the [hierarchies or nodes](/docs/api/pxm/products/hierarchies) associated wit…
3 properties
CartItemCustomAttributes
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-rule-promotions-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
Where this information came from

This is an independent, third-party profile of Elastic Path Rule Promotions 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.