Catalogs

Gets all authorized catalogs

Retrieves a list of all the catalogs that you are authorized to view. 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. See Publish a catalog.

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.

Filtering

This endpoint supports filtering. For general filtering syntax, see Filtering. The following operators and attributes are available when filtering on this endpoint.

Operator	Description	Supported Attributes	Example
eq	Checks if the values of two operands are equal. If they are, the condition is true.	name,	filter=eq(name,some-name)
in	Checks if the values are included in the specified list. If they are, the condition is true.	name	filter=in(name,some-name,some-name2)
like	Checks if the operand contains the specified string. Wildcards are supported	name	filter=like(name,some-name)

get/catalogs

Request

Base URL
https://euwest.api.elasticpath.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/elasticpath/apis/catalogs-introduction/docs/catalogs/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

filterstring

This endpoint supports filtering, see Filtering.

page[limit]integer

The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the page length store setting is used.

page[offset]integer

The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.

Response

The list of catalogs.

Example response

{
  "data": [
    {
      "id": "8dbb35b2-ef04-477e-974d-e5f3abe6faae",
      "attributes": {
        "name": "catalog-123",
        "description": "Catalog for Store 123",
        "created_at": "2020-09-22T09:00:00",
        "updated_at": "2020-09-22T09:00:00",
        "enable_price_segmentation": true,
        "max_published_releases": 2
      },
      "type": "catalog"
    }
  ]
}

Changes

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