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

The Rule Promotion Codes API from Elastic Path — 2 operation(s) for rule promotion codes.

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

This API exposes 4 operations across 2 paths, and defines 10 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 2 paths 10 schemas 2 DELETE1 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 Codes 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 2 paths, the API surfaces 4 operations — 2 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Rule Promotion Codes 4
POST
/v2/rule-promotions/{promotionID}/codes
Create Rule Promotion Codes
createRulePromotionCodes 2 params body → 201400422
GET
/v2/rule-promotions/{promotionID}/codes
Get Rule Promotion Codes
getRulePromotionCodes 4 params → 200
DELETE
/v2/rule-promotions/{promotionID}/codes
Delete Rule Promotion Codes
deleteRulePromotionCodes 2 params body → 204400
DELETE
/v2/rule-promotions/{promotionID}/codes/{codeID}
Delete A Single Rule Promotion Code
deleteSingleRulePromotionCode 3 params → 204

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are GetPromotionCodeResponse (11 properties), CreatePromotionCodeResponse (9 properties), PaginationLinks (5 properties), PromotionCodeMessage (3 properties). Each schema is shown below with its type and property counts.

CreatePromotionCodeResponse
object
9 properties
MaxUsesPerShopper
object
Object for setting max uses per shopper. Only include this object, when you want to set limit per shopper.
2 properties
GetPromotionCodesResponse
object
3 properties
CreatePromotionCodesResponse
object
2 properties
PaginationMeta
object
2 properties
PaginationLinks
object
5 properties
PromotionCodesRequest
object
1 property
Response.Error
object
1 property
PromotionCodeMessage
object
3 properties
GetPromotionCodeResponse
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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