Elastic Path Rule Promotions API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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.1.0, at version 25.1126.6886238.

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.1.0

API Version

25.1126.6886238

Base URL

https://useast.api.elasticpath.com

Authentication

HTTP Bearer

Contact

Elastic Path

License

MIT

Resource Areas

Authentication & Security 1

Elastic Path Rule Promotions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

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), ItemAttribute (4 properties). Each schema is shown below with its type and property counts.

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

RulePromotionResponse

object

1 property

CartTotalArg

array

ItemQuantity

object

3 properties

ItemQuantityCondition

object

Quantity-based condition for targeting items based on their cart quantity. Useful for bulk discount requirements or minimum quantity thresholds.

3 properties

FixedPriceQuantityArg

array

Set the amount to this fixed value.

CartDiscount

object

4 properties

ShippingDiscount

object

3 properties

ItemsBundle

object

2 properties

AccountTags

object

3 properties

ItemProductId

object

3 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

FixedPriceArg

array

Set the amount to this fixed value.

CartTotalRangeArg

array

object

2 properties

ItemsBundleCondition

object

Bundle condition for targeting specific item combinations. Only supported in items bundle discount actions for defining required item groups.

2 properties

PercentArg

array

Apply a percentage based discount to the amount.

RulePromotionBaseRuleSetBaseAttributes

object

1 property

Response.Error

object

1 property

CartCustomAttributes

object

3 properties

CartItemCustomAttributes

object

4 properties

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

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

RulePromotionBaseAttributes

object

15 properties

ShippingTypeCondition

object

Shipping type condition for targeting discounts based on shipping method. Only supported in shipping discount actions.

3 properties

ItemDiscount

object

4 properties

ItemIdentifier

object

4 properties

RulePromotionListResponse

object

3 properties

ItemAttribute

object

4 properties

And

object

2 properties

ItemSku

object

3 properties

ItemPrice

object

4 properties

CartTotal

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

ItemPriceCondition

object

Price-based condition for targeting items based on their unit price. Allows filtering by price ranges using comparison operators.

3 properties

ItemCategory

object

4 properties

ItemAttributeCondition

object

Attribute-based condition for targeting items by their custom attributes. Allows complex filtering based on product metadata and characteristics.

3 properties

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

PaginationMeta

object

2 properties

PaginationLinks

object

5 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

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…

BundleDiscount

object

4 properties

FixedArg

array

Apply a fixed discount to the amount.

RulePromotionItem

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Elastic Path publishes across the network.

Elastic Path GraphQL API

AE Profile APIs.io

Elastic Path Account Addresses API

AE Profile APIs.io

Elastic Path Account Authentication Settings API

AE Profile APIs.io

Elastic Path Account Cart Associations API

AE Profile APIs.io

Elastic Path Account Management Authentication API

AE Profile APIs.io

Elastic Path Account Members API

AE Profile APIs.io

Elastic Path Account Membership API

AE Profile APIs.io

Elastic Path Account Membership Settings API

AE Profile APIs.io

Elastic Path Account Tags API

AE Profile APIs.io

Elastic Path Accounts API

AE Profile APIs.io

Elastic Path Administrator Latest Releases Catalog API API

AE Profile APIs.io

Elastic Path Application Keys API

AE Profile APIs.io

#Rule Promotions

← Back to E APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Elastic Path Rule Promotions API

Metadata

Authentication & Security 1

Paths & Operations 5

Schemas 45

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Elastic Path Rule Promotions API

Metadata

Authentication & Security 1

Paths & Operations 5

Schemas 45

Specification

Source

More from Elastic Path 12

API Details

Provider

Explore more