Skip to main content

Get a catalog by ID

GET 

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

Retrieves the specified catalog.

Request

Path Parameters

    catalog_id stringrequired

    The catalog ID.

Responses

The catalog.

Schema
    data objectrequired

    Creates a catalog with the following attributes.

    idstringrequired

    A unique identifier of a catalog.

    Example: 8dbb35b2-ef04-477e-974d-e5f3abe6faae
    attributes objectrequired
    namestringrequired

    The name of a catalog.

    Example: catalog-123
    descriptionstring

    A brief description of the catalog, such as the purpose of the catalog.

    Default value:
    Example: Catalog for Store 123
    hierarchy_idsstring[]required

    The unique identifiers of the hierarchies associated with a catalog.

    pricebook_idstring

    The unique identifier of a price book associated with a catalog. If no price book is selected, the catalog is displayed without prices.

    pricebook_ids object[]

    If you want multiple price books for different scenarios, such as seasonal sales, business versus retail pricing, and reward programs, when creating a catalog, you can specify up to five price books. You must configure a priority for your price books. Product prices are displayed in the catalog according to the priority of the price books.

    Possible values: <= 5

  • Array [
  • iduuidrequired

    A unique identifier of a price book.

    priorityintegerrequired

    Priority is a number and the price book with the highest number has the highest priority.

  • ]
  • locales object

    Product Experience Manager supports localization of products and hierarchies. If you store supports multiple languages, you can localize product names and descriptions.

    property name* object

    A three-letter language code that represents the name of language you have used.

    property name*string

    A three-letter language code that represents the name of language you have used.

    created_atdate-timerequired

    The date and time a catalog is created.

    Example: 2020-09-22T09:00:00
    updated_atdate-timerequired

    The date and time a catalog was updated.

    Example: 2020-09-22T09:00:00
    ownerstringnullable

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

    Possible values: [store, organization]

    Default value: store
    relationships object

    Relationships are established between different catalog entities. For example, a catalog rule and a price book are related to a catalog, as both are associated with it.

    rules object

    The catalog rules related to a catalog.

    links object

    A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.

    relatedstringrequired

    A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.

    releases object

    When a catalog is published, a catalog release is created. This is a URL to all catalog published releases available for this catalog.

    links object

    A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.

    relatedstringrequired

    A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.

    meta object
    countinteger

    The number releases available for a catalog.

    typestringrequired

    Possible values: [catalog]

    Example: catalog
    links object

    Links allow you to move between requests.

    selfurinullable

    Single entities use a self parameter with a link the specific resource.

    firsturinullable

    Always the first page.

    lasturinullable

    This is null if there is only one page.

    prevurinullable

    This is null if there is only one page.

    nexturinullable

    This is null if there is only one page.

Authorization: Authorization

name: Authorizationtype: httpin: headerscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://euwest.api.elasticpath.com/catalogs/:catalog_id");
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());
Request Collapse all
Base URL
https://euwest.api.elasticpath.com
Auth
Parameters
— pathrequired
ResponseClear

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