Get the catalog release as shoppers

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

Returns a list of all published releases of the specified catalog.

Request

Header Parameters

accept-language string

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

EP-Channel string

The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the EP-Channel header in your requests.

EP-Context-Tag string

Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the EP-Context-Tag header.

Responses

200
default

The catalog.

Schema:

Schema

data object

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

idstring

A unique identifier for the catalog release.

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

attributes object

relationships object

typestring

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

meta object

A release's metadata.

created_atstring<date-time>

The date and time a release is created.

Example: 1970-01-01T00:00:00.000

started_atstring<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.

Example: 1970-01-01T00:00:00.000

updated_atstring<date-time>nullable

The date and time a release is updated.

Example: 1970-01-01T00:00:00.000

release_statusstring

The status of the current release.

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

languagestring

Your storefront's preferred language code and locale.

Example: en-GB

is_full_publishboolean

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.

Default value: false

Example: false

is_full_deltaboolean

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.

Default value: false

Example: false

total_productsinteger<int64>nullable

The total number of products displayed in a catalog release.

total_nodesinteger<int64>nullable

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

percent_completedinteger<int32>nullable

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

ownerstringnullable

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

Possible values: [store, organization]

price_segmentation_enabledboolean

This indicates whether the catalog release will support price segmentation using catalog rules to define which pricebook(s) to use for pricing

links object

{
  "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",
      "price_segmentation_enabled": true
    }
  },
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}

The unexpected error.

Schema:

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/catalog");
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!

Get the catalog release as shoppers

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

Request​

Header Parameters

Responses​

Authorization: Authorization

Request

Responses