--- title: "Get the catalog release as shoppers" method: GET path: "/catalog" tags: ["Releases"] --- # Get the catalog release as shoppers `GET /catalog` ## Request - Base URL: `https://euwest.api.elasticpath.com` - URL: `https://euwest.api.elasticpath.com/catalog` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns a list of all published releases of the specified catalog. ## Headers - `accept-language` string - `EP-Channel` string - `EP-Context-Tag` string ## Response `200` The catalog. - ReleaseData: Container for a catalog release. - `data` Release: 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` string, date-time, nullable: 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` NodeReference[]: An array of hierarchy IDs associated with the release. - `id` string: The unique identifier of a hierarchy. - `label` string: A label for a hierarchy. - `name` string: The name of a hierarchy. - `relationships` ReleaseRelationships: 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` RelatedLink: A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas. - `related` string, required: 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` RelatedLink: A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas. - `related` string, required: 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` RelatedLink, required: A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas. - `related` string, required: 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` ReleaseMeta: A release's metadata. - `created_at` string, date-time: The date and time a release is created. - `started_at` string, 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. - `updated_at` string, date-time, nullable: The date and time a release is updated. - `release_status` '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` integer, nullable: The total number of products displayed in a catalog release. - `total_nodes` integer, nullable: The total number of hierarchy nodes displayed in a catalog release. - `percent_completed` integer, nullable: An integer that represents the progress of a catalog publish. The attribute starts at `0` and reaches `100` when publishing is complete. - `owner` 'store' | 'organization', nullable: The owner of the resource, can be either `organization` or `store`. - `price_segmentation_enabled` boolean: This indicates whether the catalog release will support price segmentation using catalog rules to define which pricebook(s) to use for pricing - `indexing_duration_ms` integer, nullable: The elapsed time in milliseconds Catalog Search spent indexing this release. - `includes_draft_products` boolean: When `true`, this catalog release includes `draft` products in its published data. This reflects the catalog `include_draft_products` attribute at the time of publish. - `allow_search_overrides` boolean, nullable: When `true`, search overrides are allowed for this catalog release. This is the catalog `allow_search_overrides` attribute at the time the release was created. Defaults to `false`. - `links` Links: Links allow you to move between requests. - `self` string, uri-reference, nullable: Single entities use a `self` parameter with a link the specific resource. - `first` string, uri-reference, nullable: Always the first page. - `last` string, uri-reference, nullable: This is `null` if there is only one page. - `prev` string, uri-reference, nullable: This is `null` if there is only one page. - `next` string, uri-reference, nullable: This is `null` if there is only one page. ## Other responses - `default`: The unexpected error. --- [API](https://skmtc.dev/elasticpath/apis/catalogs-introduction.md) - [All operations](https://skmtc.dev/elasticpath/apis/catalogs-introduction/llms.txt) - [OpenAPI document](https://skmtc.dev/elasticpath/apis/catalogs-introduction/revisions/eb541d5dea51?raw)