Gets all authorized catalogs

GET https://euwest.api.elasticpath.com/catalogs

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

Responses

200
default

The list of catalogs.

application/json

Schema
Example (auto)

Schema

data object[]required

Array [

idstringrequired

A unique identifier of a catalog.

Example: 8dbb35b2-ef04-477e-974d-e5f3abe6faae

attributes objectrequired

relationships object

typestringrequired

Possible values: [catalog]

Example: catalog

]

links object

{
  "data": [
    {
      "id": "8dbb35b2-ef04-477e-974d-e5f3abe6faae",
      "attributes": {
        "name": "catalog-123",
        "description": "Catalog for Store 123",
        "hierarchy_ids": [
          "string"
        ],
        "pricebook_id": "string",
        "pricebook_ids": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "priority": 0
          }
        ],
        "locales": {},
        "created_at": "2020-09-22T09:00:00",
        "updated_at": "2020-09-22T09:00:00",
        "owner": "store"
      },
      "relationships": {
        "rules": {
          "links": {
            "related": "string"
          }
        },
        "releases": {
          "links": {
            "related": "string"
          },
          "meta": {
            "count": 0
          }
        }
      },
      "type": "catalog"
    }
  ],
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}

An unexpected error.

application/json

Schema
Example (auto)

Schema

errors object[]

{
  "errors": [
    {
      "detail": "not processable",
      "status": "422",
      "title": "There was a problem processing your request."
    }
  ]
}

Authorization: Authorization

name: Authorizationtype: httpin: headerscheme: bearer

HTTPCLIENT
RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://euwest.api.elasticpath.com/catalogs");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <Authorization>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

ResponseClear

Click the Send API Request button above and see the response here!

Gets all authorized catalogs

https://euwest.api.elasticpath.com/catalogs

Responses​

Authorization: Authorization

Responses