ELelasticpath
Releases

Gets all authorized catalog releases

Returns a list of all published releases of the specified catalog. A new catalog keeps two published releases. Set max_published_releases to 1, 2, or 3. A catalog that has never stored max_published_releases keeps 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.

get/catalogs/{catalog_id}/releases

Request

Path parameters

catalog_idstring required

The catalog ID.

Headers

accept-languagestring

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

Response

The list of catalogs.

Example response

{
  "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"
          }
        ]
      },
      "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",
        "language": "en-GB"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.