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

When a catalog is published, a catalog release is created. A catalog release provides a snapshot of the product information taken at the time of publication. You can have one or more catalog releases available in your organization or in your store. If you publish a catalog for your organization, the catalog is available when the store is launched.If you have more than one catalog published for your store, use catalog rules to specify when to display each catalog. For example, you can use [**catalog rules**](/docs/api/pxm/catalog/rules) to schedule a catalog to appear during a particular date and time, such as a seasonal catalog. The catalog may have different pricing than the other catalogs.When a catalog is ready to be used in a store, you publish it. You can create and publish catalogs for different contexts and channels.Here are some pointers to understand a catalogs' lifecycle.- The default catalog is always the oldest published catalog and must have have at least one release.- At any time, the most recent three catalog releases are maintained. Hence, if there is a fourth catalog release, the first catalog release is automatically removed.- Until the catalog is published again, the previously created three catalog releases stay permanently.- If you want any other catalog to become the default catalog, you must create a catalog rule.- If you want the oldest published catalog to become the default catalog, you must remove the catalog rule.- Use the `sort_order` value in the `variations` to program your storefront to display the variation options in the order that you want.Here is a diagram that describes a catalogs' lifecycle:![Catalogs' Lifecycle](/assets/catalog-lifecycle.png)### Publishing catalogsWhen you publish a catalog, the `live` products in the hierarchies appear in a catalog release. A catalog release provides a snapshot of product information taken at the time of publication. You can have one or more catalog releases available in your organization or in your store. If you publish a catalog for your organization, the catalog is available when the store is launched.If you have more than one catalog published for your store, use catalog rules to specify when to display each catalog. For example, you can use [catalog rules](/docs/api/pxm/catalog/rules) to schedule a catalog to appear during a particular date and time, such as a seasonal catalog. The catalog may have different pricing than the other catalogs. You can have multiple published catalogs.When a catalog is ready to be used in a store, you publish it. You can create and publish catalogs for different contexts and channels. You can see the differences between the last two consecutive catalog releases. See [Publish a catalog](/docs/api/pxm/catalog/publish-release).You retrieve catalogs for your shopper experience by using the [Catalog View API](/docs/api/pxm/catalog/releases).

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

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

6 operations 3 paths 11 schemas 2 DELETE3 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 Releases API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 6

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

Releases 6

When a catalog is published, a catalog release is created. A catalog release provides a snapshot of the product information taken at the time of publication. You can have one or m…

GET
/catalog
Get the catalog release as shoppers
getByContextRelease 3 params → 200default
POST
/catalogs/{catalog_id}/releases
Publishes a catalog
publishRelease 1 param body → 201default
GET
/catalogs/{catalog_id}/releases
Gets all authorized catalog releases
getReleases 2 params → 200default
DELETE
/catalogs/{catalog_id}/releases
Deletes all releases
deleteReleases 1 param → 204default
GET
/catalogs/{catalog_id}/releases/{release_id}
Get a catalog release by ID
getReleaseByID 3 params → 200default
DELETE
/catalogs/{catalog_id}/releases/{release_id}
Deletes a release
deleteReleaseByID 2 params → 204default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are release-meta (13 properties), release (5 properties), links (5 properties), node-reference (3 properties). Each schema is shown below with its type and property counts.

release
object
A catalog release represents a collection of hierarchical product data, price books and catalogs rules.
5 properties
node-reference
object
Minimum set of information to identify a catalog node.
3 properties
release-data
object
Container for a catalog release.
2 properties
error
object
APIError is a json-api style part of an error response.
3 properties
catalog-release-create-data
object
Creates a catalog release with the following attributes.
1 property
release-list-data
object
Container for a list of catalog releases.
2 properties
error-response
object
ErrorResponse is a json-api style Error response.
1 property
release-meta
object
A release's metadata.
13 properties
related-link
object
A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.
1 property 1 required
release-relationships
object
Relationships are established between different catalog entities. For example, products, hierarchies, price books, and catalog rules are related to a catalog,…
3 properties
links
object
Links allow you to move between requests.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-releases-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