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

Price books contain prices for the products in your catalog. Each catalog must have one price book. In your storefront, the product prices are displayed in the currency for the selected locale. If a product in the catalog does not have a price in the price book, the product is displayed without a price. A price book can be associated with multiple catalogs.Following on from this, you can associate more than one price book with a catalog. Price book stacking allows you to create multiple price books for different scenarios, such as seasonal sales, business versus retail customer pricing, and reward programs. If you have multiple price books, when you create a catalog, you must configure a priority for your price books. Product prices are displayed in the catalog according to the priority of the price books. For example, you may have products that have different prices based on region. You can have a price book with the standard retail pricing and then have a second price book that has different pricing for a different region. See Create a catalog.A price book contains a list of product SKUs and the prices you want to charge for those products. If your store supports multiple locales, a price book can contain product prices in each of the supported currencies. In addition, you can configure sales and volume (tier) pricing.:::notePrice books work with products that are defined using the Product Experience Manager resource model. If your products are defined using an earlier Products resource model, you will need to migrate products to the `pcm/products` resource before you implement price books.:::You can duplicate an existing price book and create a new price book. All products and prices associated with the price book are copied to the new price book. Based on the business requirements, you can use the same data or update the data.

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

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

6 operations 3 paths 24 schemas 1 DELETE2 GET2 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 Books API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 6

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

Price Books 6

Price books contain prices for the products in your catalog. Each catalog must have one price book. In your storefront, the product prices are displayed in the currency for the se…

POST
/pcm/pricebooks
Create a Price Book
createPricebook body → 201default
GET
/pcm/pricebooks
Get all Price Books
getPricebooks 3 params → 200default
GET
/pcm/pricebooks/{pricebookID}
Get a Price Book by ID
getPricebookById 2 params → 200default
PUT
/pcm/pricebooks/{pricebookID}
Update a Price Book by ID
updatePricebook 1 param body → 200default
DELETE
/pcm/pricebooks/{pricebookID}
Delete a Price Book by ID
deletePricebookById 1 param → 204default
POST
/pcm/pricebooks/{pricebookID}/replicate
Replicate a Price Book
replicatePricebook 1 param body → 201default

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are product-price (5 properties), links-pricebooks (5 properties), schedule (4 properties), pricebook (4 properties). Each schema is shown below with its type and property counts.

error-pricebooks
object
This is a json-api style part of an error response
3 properties
pricebook-replicate-data
object
Json-api style data object containing a price book to be replicated.
1 property 1 required
pricebook-with-prices-data
object
Json-api style data object containing a price book and its prices.
3 properties 1 required
pricebook-list-data
object
Json-api style array containing a list of price books
3 properties 1 required
product-price
object
5 properties 3 required
pricebook-update-data
object
1 property 1 required
shopper-attributes
object
You can add custom attributes to a product price. For example, you can set prices based on customer segments. For instance, you can offer different prices for…
pricebook-create
object
2 properties 2 required
pricebook-data
object
A price book with the following attributes.
2 properties 1 required
tier-price
object
The name of the tier, for example, Pencils.
2 properties
amount
object
The three-letter ISO code for the currency associated with this price.
3 properties
error-response-pricebooks
object
This is a json-api style error response
1 property
sales
object
The sales price that an item is eligible for based on the price book.
pricebook
object
A price book with the following attributes.
4 properties 3 required
sale
object
The name of the sale, such as Summer Sale.
3 properties
pricebook-replicate
object
Price book replicate request.
2 properties 2 required
links-pricebook
object
Links are used to allow you to move between requests.
1 property
page-meta
object
Contains the results for the entire collection.
2 properties
pricebook-create-data
object
1 property 1 required
schedule
objectnull
The schedule of the sale. If the entire schedule object is omitted or null, the sale price is considered permanent. When defining a recurring sale with rrule,…
4 properties
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…
links-pricebooks
object
Links are used to allow you to move between requests. Single entities use a self parameter with a link to that specific resource. Sometimes, there aren’t enoug…
5 properties
admin-attributes
object
You can add custom attributes to a product price. For example, you may want to add custom attributes that can automate price updates based on predefined rules,…
pricebook-update
object
Updates the specified price book.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-price-books-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
Where this information came from

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