Gets all authorized catalog releases

GET 
https://euwest.api.elasticpath.com/catalogs/:catalog_id/releases

Returns a list of all published releases of the specified catalog. Currently, published catalogs are limited to the current release and two releases prior to the current release. You can see the differences between the last 2 consecutive catalog releases using the delta link returned in the response of a publish a catalog endpoint.

You can use the is_full_delta attribute returned from the get a release of a catalog endpoint to determine if you need to refresh the data in your company system before publishing a catalog release and injecting fresh data in a delta link. The is_full_delta attribute tells you if this is a full publish of a catalog release. Using a search service as an example, if the is_full_delta attribute is true, you should remove all data about that catalog from the search service before publishing a catalog release and injecting fresh data from the delta file.

If the is_full_publish attribute returned in the response is false, data from the previous catalog release overlaid the existing data in the delta file. The is_full_publish attribute is always true the first time a catalog is published. When determining whether delta data needs to be refreshed, ignore this attribute and always use the is_full_delta attribute.

Request

Path Parameters

catalog_id stringrequired

The catalog ID.

Header Parameters

accept-language string

The language and locale your storefront prefers. See Accept-Language.

Responses

200

The list of catalogs.

application/json

Schema

Schema

data object[]
Array [
idstring
A unique identifier for the catalog release.
Example: 8dbb35b2-ef04-477e-974d-e5f3abe6faae
attributes object
namestring
The name of a release.
Example: Clothing
published_atstring<date-time>nullable
The date and time a release was published.
Example: 1970-01-01T00:00:00.000
catalog_idstring
A unique identifier for the catalog.
Example: 0194f54d-f2a1-4e33-9a6e-9ec366152490
descriptionstring
A description of the catalog release.
Default value:
Example: Catalog for Store 123
hierarchies object[]
An array of hierarchy IDs associated with the release.
Array [
idstring
The unique identifier of a hierarchy.
Example: 65477ce0-fcb8-436b-a120-3d57979421dd
labelstring
A label for a hierarchy.
Example: category
namestring
The name of a hierarchy.
Example: Formal dresswear
]
relationships object
Relationships are established between different catalog entities. For example, products, hierarchies, price books, and catalog rules are related to a catalog, as they are associated with it.
delta object
A URL to a delta document that describes the changes between catalog releases.
links object
A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.
relatedstringrequired
A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.
products object
A URL to all products included in a catalog release.
links object
A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.
relatedstringrequired
A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.
hierarchies object
A URL to all hierarchies included in a catalog release.
links objectrequired
A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.
relatedstringrequired
A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.
typestring
This represents the type of object being returned. Always catalog-release.
meta object
A release's metadata.
created_atstring<date-time>
The date and time a release is created.
Example: 1970-01-01T00:00:00.000
started_atstring<date-time>nullable
The date and time a release is available for use. In other words, the date and time the status of a catalog release changes to PUBLISHED, rather than IN PROGRESS.
Example: 1970-01-01T00:00:00.000
updated_atstring<date-time>nullable
The date and time a release is updated.
Example: 1970-01-01T00:00:00.000
release_statusstring
The status of the current release.
Possible values: [PENDING, IN_PROGRESS, FAILED, PUBLISHED]
languagestring
Your storefront's preferred language code and locale.
Example: en-GB
is_full_publishboolean
Indicates that a full publish was performed (either because this is the first time a catalog has been published or because of a change that occurred, for example, adding/removing a price book or hierarchy). When determining whether delta data needs to be refreshed, ignore this attribute and always use the is_full_delta attribute.
Default value: false
Example: false
is_full_deltaboolean
Indicates whether the release delta file contains the full content of a catalog release. Using a search service as an example, if the is_full_delta attribute is true, you should remove all data about that catalog release from the search service before injecting fresh data from the delta file. If the is_full_delta attribute is false, then data from the previous catalog release overlays the existing data in the delta file. The is_full_delta attribute is always true the first time a catalog is published.
Default value: false
Example: false
total_productsinteger<int64>nullable
The total number of products displayed in a catalog release.
total_nodesinteger<int64>nullable
The total number of hierarchy nodes displayed in a catalog release.
percent_completedinteger<int32>nullable
An integer that represents the progress of a catalog publish. The attribute starts at 0 and reaches 100 when publishing is complete.
ownerstringnullable
The owner of the resource, can be either organization or store.
Possible values: [store, organization]
price_segmentation_enabledboolean
This indicates whether the catalog release will support price segmentation using catalog rules to define which pricebook(s) to use for pricing
]
links object

Links allow you to move between requests.

selfstring<uri>nullable

Single entities use a self parameter with a link the specific resource.

firststring<uri>nullable

Always the first page.

laststring<uri>nullable

This is null if there is only one page.

prevstring<uri>nullable

This is null if there is only one page.

nextstring<uri>nullable

This is null if there is only one page.

Example (auto)

{
  "data": [
    {
      "id": "8dbb35b2-ef04-477e-974d-e5f3abe6faae",
      "attributes": {
        "name": "Clothing",
        "published_at": "1970-01-01T00:00:00.000",
        "catalog_id": "0194f54d-f2a1-4e33-9a6e-9ec366152490",
        "description": "Catalog for Store 123",
        "hierarchies": [
          {
            "id": "65477ce0-fcb8-436b-a120-3d57979421dd",
            "label": "category",
            "name": "Formal dresswear"
          }
        ]
      },
      "relationships": {
        "delta": {
          "links": {
            "related": "string"
          }
        },
        "products": {
          "links": {
            "related": "string"
          }
        },
        "hierarchies": {
          "links": {
            "related": "string"
          }
        }
      },
      "type": "string",
      "meta": {
        "created_at": "1970-01-01T00:00:00.000",
        "started_at": "1970-01-01T00:00:00.000",
        "updated_at": "1970-01-01T00:00:00.000",
        "release_status": "PENDING",
        "language": "en-GB",
        "is_full_publish": false,
        "is_full_delta": false,
        "total_products": 0,
        "total_nodes": 0,
        "percent_completed": 0,
        "owner": "store",
        "price_segmentation_enabled": true
      }
    }
  ],
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}

default

The unexpected error.

application/json

Schema

Schema

errors object[]
Array [
detailstring
Example: not processable
statusstring
Example: 422
titlestring
Example: There was a problem processing your request.
]

Example (auto)

{
  "errors": [
    {
      "detail": "not processable",
      "status": "422",
      "title": "There was a problem processing your request."
    }
  ]
}

Authorization: Authorization

name: Authorizationtype: httpin: headerscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://euwest.api.elasticpath.com/catalogs/:catalog_id/releases");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <Authorization>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://euwest.api.elasticpath.com

Auth

Bearer Token

Parameters

catalog_id — pathrequired

accept-language — header

ResponseClear

Click the Send API Request button above and see the response here!