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.1.0, at version 25.1126.6886238.
Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Elastic Path Price Book Modifiers 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.
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 ca…
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), amount (3 properties), price-modifier-list-data (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elastic Path 12
Other APIs Elastic Path publishes across the network.