Catalogs

Updates a catalog

Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the catalog is not updated.

put/catalogs/{catalog_id}

Request

Base URL
https://euwest.api.elasticpath.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/elasticpath/apis/catalogs-introduction/docs/catalogs/:catalog_id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

catalog_idstring required

The catalog ID.

Request body

Example request

{
  "data": {
    "attributes": {
      "name": "catalog-123",
      "description": "Catalog for Store 123",
      "enable_price_segmentation": true,
      "max_published_releases": 2
    },
    "id": "8dbb35b2-ef04-477e-974d-e5f3abe6faae",
    "type": "catalog"
  }
}

Response

An updated catalog with the following attributes.

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.