Get the catalog release as shoppers

GET 
https://euwest.api.elasticpath.com/pcm/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

Product tags are used to store or assign a key word against a product. The product tag can then be used to describe or label that product. Using product tags means that you can group your products together, for example, by brand, category, subcategory, colors, types, industries, and so on. You can enhance your product list using tags, enabling you to refine your product list and run targeted promotions. 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

The catalog.

application/json

Schema

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.

Example (from schema)

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

default

The unexpected error.

application/json

Schema

Schema

errors object[]
Array [
detail string
status string
title string
]

Example (from schema)

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://euwest.api.elasticpath.com/pcm/catalog' \
-H 'Accept: application/json'

Request Collapse all

Base URL

https://euwest.api.elasticpath.com

Parameters

accept-language — header

EP-Channel — header

EP-Context-Tag — header

ResponseClear

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