Update Catalog

Updates a catalog

PUT/catalogs/{catalog_id}

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the Update Catalog action (under Catalog).
Fill in the fields below, then reference the result from later steps as {{updateCatalog.response.data}}.

Request

Path parameters

catalog_idstringrequired

The catalog ID.

Request body

Enter the body as JSON in the step's Body field.

dataobjectrequired

attributesobjectrequired8 fields

idstringrequired

The unique identifier of the catalog to be updated.

typestringrequired

This represents the type of object being returned. Always `catalog`.

One ofcatalog

json

{
  "data": {
    "attributes": {
      "name": "catalog-123",
      "description": "Catalog for Store 123",
      "hierarchy_ids": [
        "string"
      ],
      "pricebook_id": "string",
      "pricebook_ids": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "priority": 0
        }
      ],
      "locales": {},
      "enable_price_segmentation": true,
      "include_draft_products": false
    },
    "id": "8dbb35b2-ef04-477e-974d-e5f3abe6faae",
    "type": "catalog"
  }
}

Response

Returns 200 with an object. Read it in later steps with {{updateCatalog.response.data.<field>}}.

dataobject

Creates a catalog with the following attributes.

idstringrequired

A unique identifier of a catalog.

attributesobjectrequired11 fields

relationshipsobject2 fields

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.

typestringrequired

One ofcatalog

linksobject

Links allow you to move between requests.

selfstring (uri)

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

firststring (uri)

Always the first page.

laststring (uri)

This is `null` if there is only one page.

prevstring (uri)

This is `null` if there is only one page.

nextstring (uri)

This is `null` if there is only one page.

json

{
  "data": {
    "id": "8dbb35b2-ef04-477e-974d-e5f3abe6faae",
    "attributes": {
      "name": "catalog-123",
      "hierarchy_ids": [
        "string"
      ],
      "created_at": "2020-09-22T09:00:00",
      "updated_at": "2020-09-22T09:00:00",
      "description": "Catalog for Store 123",
      "pricebook_id": "string",
      "pricebook_ids": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "priority": 0
        }
      ],
      "locales": {},
      "owner": "store",
      "enable_price_segmentation": true,
      "include_draft_products": false
    },
    "type": "catalog",
    "relationships": {
      "rules": {
        "links": {
          "related": "string"
        }
      },
      "releases": {
        "links": {
          "related": "string"
        },
        "meta": {
          "count": 0
        }
      }
    }
  },
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.

Was this page helpful?