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 Usages API

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

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

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

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

Paths & Operations 3

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

Rule Promotion Usages 3
POST
/v2/rule-promotions/usages/anonymize
Anonymize Rule Promotion Usages
anonymizeRulePromotionUsages body → 200400401404
GET
/v2/rule-promotions/{promotionID}/usages
Get Rule Promotion Usages
getRulePromotionUsages 5 params → 200401404
GET
/v2/rule-promotions/{promotionID}/codes/{code}/usages
Get Rule Promotion Code Usages
getRulePromotionCodeUsages 6 params → 200401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are RulePromotionUsage (12 properties), PaginationLinks (5 properties), PaginationMeta (2 properties), Response.Error (1 property). Each schema is shown below with its type and property counts.

RulePromotionUsage
object
Represents a single rule promotion usage record.
12 properties
PaginationMeta
object
2 properties
PaginationLinks
object
5 properties
Response.Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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