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 Price Book Modifiers API

You can use price modifiers to change the price property of child products. By default, child products inherit the same price as their base products. Using price modifiers, you can enable child products to inherit a different price. This enables you to configure the price of child products, for example, to be lower than its base product, without having to individually update the price of your child products. There are three types of price modifier.| Modifier | Data Type | Effect ||:------------------|:----------|:---------------------------------------------|| `price_increment` | `string` | Increases the price of a product. || `price_decrement` | `string` | Decreases the price of a product. || `price_equals` | `string` | Sets the price of a product to the amount you specify. |The following is an overview of the steps you need to follow to use price modifiers.1. Create a price modifier. You must give the price modifier a unique name. For more information, see [Create a Price Modifier](/docs/api/pxm/pricebooks/create-price-modifier).1. Build your child products with the new product modifier.

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

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

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

5 operations 2 paths 15 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.0529.7665911
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Elastic Path Price Book Modifiers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). 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.

Price Book Modifiers 5

You can use price modifiers to change the price property of child products.

POST
/pcm/pricebooks/{pricebookID}/modifiers
Create a Modifier
createPriceModifier 1 param body → 201default
GET
/pcm/pricebooks/{pricebookID}/modifiers
Gets a list of all modifiers
getPriceModifiers 4 params → 200default
GET
/pcm/pricebooks/{pricebookID}/modifiers/{modifierID}
Get a Modifier
getPriceModifierByID 2 params → 200default
PUT
/pcm/pricebooks/{pricebookID}/modifiers/{modifierID}
Update a Modifier
updatePriceModifier 2 params body → 200default
DELETE
/pcm/pricebooks/{pricebookID}/modifiers/{modifierID}
Delete a Modifier
deletePriceModifier 2 params → 204default

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are links-modifiers (5 properties), price-modifier (5 properties), error-modifiers (3 properties), amount (3 properties). Each schema is shown below with its type and property counts.

tier-price
object
The name of the tier, for example, Pencils.
2 properties
price-modifier-data
object
Json-api style data object containing a single price modifier.
2 properties 1 required
links-modifier
object
Links are used to allow you to move between requests.
1 property
links-modifiers
object
Links are used to allow you to move between requests.
5 properties
price-modifier-update
object
Price modifier update request.
3 properties 3 required
currencies
object
A collection of one or more currencies objects that consists of the [three-letter ISO code](https://www.iso.org/iso-3166-country-codes.html) of the currencies…
error-modifiers
object
This is a json-api style part of an error response
3 properties
amount
object
The three-letter ISO code for the currency associated with this price.
3 properties
error-response-modifiers
object
This is a json-api style error response
1 property
price-modifier-update-data
object
Json-api style data object containing a price modifier to be updated.
1 property 1 required
price-modifier-list-data
object
Json-api style array containing a list of price modifiers.
3 properties 1 required
price-modifier-create
object
2 properties 2 required
page-meta
object
Contains the results for the entire collection.
2 properties
price-modifier
object
A price modifier with the following attributes.
5 properties 3 required
price-modifier-create-data
object
Json-api style data object containing a price modifier to be created.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-price-book-modifiers-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
Elastic Path Application Keys API
Where this information came from

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