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 Administrator Latest Releases Catalog API

Use the Administrator Latest Releases Catalog View API to retrieve product, hierarchy and node information.:::dangerThe Administrator Latest Releases Catalog View API is for Administrator use only. Do not use these endpoints on your customer-facing frontends.:::Publishing a catalog creates a release of that catalog that you can use in an organization or in a specific store or other shopper experience. You can retrieve the hierarchies, nodes, and the `live` products associated with a catalog release. You can see which parent nodes a product is associated with. This is useful if want to improve how your shoppers search your store, for example.Currently, published catalogs are limited to the current release and two releases prior to the current release.

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

This API exposes 14 operations across 14 paths, and defines 60 schemas. It is described by OpenAPI 3.2.0, at version 26.0508.7574130.

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

14 operations 14 paths 60 schemas 14 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
26.0508.7574130
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Elastic Path Administrator Latest Releases Catalog API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 14

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

Administrator Latest Releases Catalog API 14

Use the Administrator Latest Releases Catalog View API to retrieve product, hierarchy and node information.

GET
/catalogs/{catalog_id}/releases/{release_id}/hierarchies
Get all Hierarchies
getAllHierarchies 6 params → 200default
GET
/catalogs/{catalog_id}/releases/{release_id}/hierarchies/{hierarchy_id}
Get a Hierarchy
getHierarchy 4 params → 200default
GET
/catalogs/{catalog_id}/releases/{release_id}/hierarchies/{hierarchy_id}/nodes
Get a Hierarchy's Nodes
getHierarchyNodes 7 params → 200default
GET
/catalogs/{catalog_id}/releases/{release_id}/hierarchies/{hierarchy_id}/children
Get a Hierarchy's Children
getHierarchyChildNodes 7 params → 200default
GET
/catalogs/{catalog_id}/releases/{release_id}/nodes
Get all Nodes
getAllNodes 6 params → 200default
GET
/catalogs/{catalog_id}/releases/{release_id}/nodes/{node_id}
Get a Node
getNode 4 params → 200default
GET
/catalogs/{catalog_id}/releases/{release_id}/nodes/{node_id}/relationships/children
Get a Node's Children
getChildNodes 7 params → 200default
GET
/catalogs/{catalog_id}/releases/{release_id}/products
Get all Products
getAllProducts 9 params → 200default
GET
/catalogs/{catalog_id}/releases/{release_id}/products/{product_id}
Get a Product
getProduct 7 params → 200default
GET
/catalogs/{catalog_id}/releases/{release_id}/products/{product_id}/relationships/{custom_relationship_slug}/products
Get all Related Products of a Product
getAllRelatedProducts 10 params → 200default
GET
/catalogs/{catalog_id}/releases/{release_id}/products/{product_id}/relationships/component_products
Get a Bundle's Component Products
getComponentProductIDs 8 params → 200default
GET
/catalogs/{catalog_id}/releases/{release_id}/products/{product_id}/relationships/children
Get a Parent Product's Child Products
getChildProducts 10 params → 200default
GET
/catalogs/{catalog_id}/releases/{release_id}/hierarchies/{hierarchy_id}/products
Get a Hierarchy's Products
getProductsForHierarchy 10 params → 200default
GET
/catalogs/{catalog_id}/releases/{release_id}/nodes/{node_id}/relationships/products
Get a Node's Products
getProductsForNode 10 params → 200default

Schemas 60

The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are product-meta (25 properties), product-attributes (23 properties), node-attributes (10 properties), elastic-path-file (9 properties). Each schema is shown below with its type and property counts.

custom-input
object
The name of the custom input. You can rename the input to something more representative of the input that shoppers are adding, for example, message or front.
3 properties
custom-input-validation-rule
object
The validation rules for the custom text.
2 properties
schedule
object
A definition of the times at which a sale is valid
2 properties
related-link
object
A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.
1 property 1 required
display-price
object
A price formatted for display.
2 properties
tiered-amount
object
The three-letter ISO code for the currency associated with this price.
3 properties
included-response
object
Included is an array of resources that are included in the response.
3 properties
product
object
A product in a catalog with the following attributes.
5 properties
product-references
array
A list of product identifiers.
links
object
Links allow you to move between requests.
5 properties
node-meta
object
A node's metadata.
4 properties
custom-relationship
object
A product can have custom relationships added that link to other products. These can be used for Parent/Child relationships as well as products that you want t…
2 properties
sale
object
A set of sale prices and a validity period.
2 properties
hierarchy-meta
object
A hierarchy's metadata.
3 properties
files-relationship
object
In Product Experience Manager, products can have associated rich media assets, such as product images or a file containing additional product details.
1 property
node-data
object
Container for nodes.
2 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…
components
object
A bundle is a purchasable product, comprising of one or more products that you want to sell together. You can create multiple components within a bundle. Each…
available-prices
array
If pricebook segmentation is enabled, this will show all the available prices for the product in the CV delta file and will show selected available prices via…
main-image-relationship
object
In Product Experience Manager, products can also have associated product images.
1 property
tier
object
The name of the tier, for example, Pencils.
2 properties
variation
object
5 properties
bundle-configuration
object
A bundle is a purchasable product, comprising of one or more products that you want to sell together. You can create multiple components within a bundle. Each…
1 property 1 required
product-meta
object
A product's metadata contains information about products, for example, the nodes a product is associated with, any child products, bundle configurations, and s…
25 properties
error-response
object
ErrorResponse is a json-api style Error response.
1 property
component-product-option
object
The product options included in a component. This can be the ID of another bundle.
9 properties
product-reference
object
A product identifier.
2 properties
custom-input-validation-rule-options
object
The length of the custom input text field.
1 property
alternative-prices
array
If pricebook segmentation is enabled, this will show all the alternative prices for the product. Will just include 'List Price' initially
hierarchy-attributes
object
Resource attributes of a catalog hierarchy.
7 properties
extension
object
The name of the product template.
formatted-price
object
A price formatted for display.
4 properties
custom-relationship-links
object
For each custom relationship in use on the product, there will be a link to follow.
variation_option
object
The options available for a variation.
4 properties
self-link
object
Links are used to allow you to move between requests.
1 property 1 required
hierarchy
object
A category hierarchy in a catalog. Hierarchies can have parent nodes and child nodes, as well as a list of attached products.
5 properties
hierarchy-relationships
object
Relationships to child nodes, and products.
3 properties
extensions
object
With extension templates, you can attach a specific set of custom fields to your products in Product Experience Manager. For example, a Book template might con…
file-reference
object
In Product Experience Manager, products can have associated rich media assets, such as product images or a file containing additional product details.
3 properties
node-list-data
object
Container for a list of nodes.
3 properties
product-list-data
object
Container for a list of products.
4 properties
component-product
object
The unique identifier of the component, for example, games.
5 properties
page-meta
object
Contains the results for the entire collection.
2 properties
tiered-currencies
object
Collection of currency specific prices for a product.
node
object
A category node in a catalog. Nodes can have child nodes, as well as a list of attached products.
5 properties
node-relationships
object
Relationships to parent and child nodes, and products.
4 properties
amount
object
The three-letter ISO code for the currency associated with this price.
2 properties
product-attributes
object
A product's attributes.
23 properties
node-attributes
object
Resource attributes of a catalog node.
10 properties
elastic-path-file
object
9 properties
hierarchy-data
object
Container for hierarchies.
2 properties
custom_inputs
object
You can allow your shoppers to add custom text to a product when adding product items to their carts. This is useful, for example, if you have a product like a…
shopper_attributes
object
A collection of key-value string pairs, viewable by shoppers.
tiers
object
The price tier that an item is eligible for based on the quantity purchased. You cannot have conflicting tiers within the same currencies block.
product-relationships
object
Relationships allow you to move between requests. Includes links to the parent and child products, bundle component products, files, and main images associated…
6 properties
error
object
APIError is a json-api style part of an error response.
3 properties
component-products-relationship
object
A bundle is a purchasable product, comprising of one or more products that you want to sell together. You can create multiple components within a bundle. Each…
2 properties
hierarchy-list-data
object
Container for a list of hierarchies.
3 properties
product-data
object
Container for products.
3 properties
product-reference-list-data
object
Container for a list of product references.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-administrator-latest-releases-catalog-api-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 Application Keys API
Elastic Path Authentication Realms API
Where this information came from

This is an independent, third-party profile of Elastic Path Administrator Latest Releases Catalog 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.