ELelasticpath
Catalogs

Creates a new catalog

Before you create a catalog, you must define the following resources:

  • Hierarchies - hierarchies and nodes to categorize the products.
  • Products - product information, associated assets, and links to hierarchy nodes.
  • Price Books - prices for the products associated with the hierarchies. You can create multiple price books for different scenarios, such as seasonal sales, business versus retail customer 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. Priority is a number and the price book with the highest number has the highest priority.
post/catalogs

Request

Request body

Example request

{
  "data": {
    "attributes": {
      "name": "catalog-123",
      "description": "Catalog for Store 123",
      "enable_price_segmentation": true,
      "max_published_releases": 2
    },
    "type": "catalog"
  }
}

Response

The created catalog

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.