Skip to main content

Get a catalog release by ID

GET 
/catalogs/:catalog_id/releases/:release_id

Retrieves the specified catalog release.

Request​

Path Parameters

    catalog_id stringrequired

    The catalog ID.

    release_id stringrequired

    The unique identifier of a published release of the catalog or latestPublished for the most recently published version.

Header Parameters

    accept-language string

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

Responses​

The catalog.

Schema
    data object

    A catalog release represents a collection of hierarchical product data, price books and catalogs rules.

    id string

    A unique identifier for the catalog release.

    attributes object
    name string

    The name of a release.

    published_at date-timenullable

    The date and time a release was published.

    catalog_id string

    A unique identifier for the catalog.

    description string

    A description of the catalog release.

    hierarchies object[]

    An array of hierarchy IDs associated with the release.

  • Array [
    • id string

    The unique identifier of a hierarchy.

    label string

    A label for a hierarchy.

    name string

    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.

    related stringrequired

    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.

    related stringrequired

    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.

    related stringrequired

    A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.

    type string

    This represents the type of object being returned. Always catalog-release.

    meta object

    A release's metadata.

    created_at date-time

    The date and time a release is created.

    started_at date-timenullable

    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.

    updated_at date-timenullable

    The date and time a release is updated.

    release_status string

    Possible values: [PENDING, IN_PROGRESS, FAILED, PUBLISHED]

    The status of the current release.

    language string

    Your storefront's preferred language code and locale.

    is_full_publish boolean

    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.

    is_full_delta boolean

    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.

    total_products int64nullable

    The total number of products displayed in a catalog release.

    total_nodes int64nullable

    The total number of hierarchy nodes displayed in a catalog release.

    percent_completed int32nullable

    An integer that represents the progress of a catalog publish. The attribute starts at 0 and reaches 100 when publishing is complete.

    owner stringnullable

    Possible values: [store, organization]

    The owner of the resource, can be either organization or store.

    links object

    Links allow you to move between requests.

    self urinullable

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

    first urinullable

    Always the first page.

    last urinullable

    This is null if there is only one page.

    prev urinullable

    This is null if there is only one page.

    next urinullable

    This is null if there is only one page.

Loading...