PXM Catalogs/
PXM Catalog Publish API/
Get all Releases of a Published Catalog

Get all Releases of a Published Catalog

GET Get all Releases of a Published Catalog

https://api.moltin.com/pcm/catalogs/:catalogId/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_publish 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 injecting fresh data in a delta link. The is_full_publish attribute tells you if this is a full publish of the catalog. Using a search service as an example, if the is_full_publish attribute is true, you should remove all data about that catalog from the search service before injecting fresh data from the delta file. If the is_full_publish attribute is false, then data from the previous catalog overlays the existing data in the delta file. The is_full_publish attribute is always true the first time a catalog is published.

Parameters

Path parameters

NameRequiredTypeDescription
catalogIdRequiredstringThe unique identifier of the catalog.

Headers

NameRequiredTypeDescription
AuthorizationRequiredstringThe Bearer token required to get access to the API. An Implicit Bearer token only returns products with live status. Products with draft status are not included.

Request Example

curl -X GET https://api.moltin.com/pcm/catalogs/aea233e7-1300-48ce-9b45-7d0c0b60dde3/releases \
     -H "Authorization: Bearer XXXX"

Response Example

200 OK

{
    "data": [
        {
            "id": "aea233e7-1300-48ce-9b45-7d0c0b60dde3",
            "type": "catalog-release",
            "attributes": {
                "hierarchies": [
                    {
                        "id": "eb3bd9e6-857c-4886-bc3f-fcebd600ae22"
                    }
                ],
                "description": "Ranges Catalog",
                "name": "Ranges Catalog",
                "published_at": "2021-04-13T02:11:57.393Z"
            },
            "meta": {
               "is_full_delta": true,
               "is_full_publish": true,
               "owner": "store",
               "created_at": "2022-03-25T18:05:13.447Z",
               "release_status": "PUBLISHED",
               "started_at": "2022-03-25T18:05:13.463Z"
           },
            "relationships": {
                "hierarchies": {
                    "links": {
                        "related": "/pcm/catalogs/aea233e7-1300-48ce-9b45-7d0c0b60dde3/releases/aea233e7-1300-48ce-9b45-7d0c0b60dde3/hierarchies"
                    }
                },
                "products": {
                    "links": {
                        "related": "/pcm/catalogs/aea233e7-1300-48ce-9b45-7d0c0b60dde3/releases/aea233e7-1300-48ce-9b45-7d0c0b60dde3/products"
                    }
                }
            }
        }
    ],
    "links": {
        "self": "/pcm/catalogs/aea233e7-1300-48ce-9b45-7d0c0b60dde3/releases"
    }
}

Was this helpful?

Learn

Docs