Gets all authorized catalog releases
GET/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.
Request
Path Parameters
The catalog ID.
Header Parameters
The language and locale your storefront prefers. See Accept-Language.
Responses
- 200
- default
The list of catalogs.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
data object[]
A unique identifier for the catalog release.
attributes object
The name of a release.
The date and time a release was published.
A unique identifier for the catalog.
A description of the catalog release.
hierarchies object[]
An array of hierarchy IDs associated with the release.
The unique identifier of a hierarchy.
A label for a hierarchy.
The name of a hierarchy.
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.
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.
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.
A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.
This represents the type of object being returned. Always catalog-release
.
meta object
A release's metadata.
The date and time a release is created.
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.
The date and time a release is updated.
Possible values: [PENDING
, IN_PROGRESS
, FAILED
, PUBLISHED
]
The status of the current release.
Your storefront's preferred language code and locale.
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.
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.
The total number of products displayed in a catalog release.
The total number of hierarchy nodes displayed in a catalog release.
An integer that represents the progress of a catalog publish. The attribute starts at 0
and reaches 100
when publishing is complete.
Possible values: [store
, organization
]
The owner of the resource, can be either organization
or store
.
links object
Links allow you to move between requests.
Single entities use a self
parameter with a link the specific resource.
Always the first page.
This is null
if there is only one page.
This is null
if there is only one page.
This is null
if there is only one page.
{
"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"
}
}
],
"links": {
"self": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
The unexpected error.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
errors object[]
{
"errors": [
{
"detail": "not processable",
"status": "422",
"title": "There was a problem processing your request."
}
]
}