Publish Release

Publishes a catalog

POST/catalogs/{catalog_id}/releases

Use it in a workflow

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

Request

Path parameters

catalog_idstringrequired

The catalog ID.

Request body

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

dataobject

export_full_deltaboolean

Set to `true` if you want to export all the data from a catalog release in a delta link. The `is_full_delta` attribute is returned from the `get a release of a catalog` endpoint. The `is_full_delta` attribute tells you if the delta file contains the full content of a catalog release. You can use the `is_full_delta` to determine if you need to refresh the data in your company system before publishing a catalog release with fresh data in a delta link. Using a search service as an example, if the `is_full_delta` attribute is true, you should remove all data about that catalog from the search service before publishing a catalog release and injecting fresh data from the delta file. If the `is_full_delta` attribute is false, then data from the previous catalog overlays the existing data in the delta file. The `is_full_delta` attribute is always `true` the first time a catalog is published.

include_organization_resourcesboolean

If you are publishing a catalog in a store that contains resources from an organization, you must set this to true and you must enable the **Include Organization Resources in Catalog Publishes** checkbox in Commerce Manager. See [**Multi-Store Management Solutions**](/docs/api/pxm/catalog/publish-release).

json

{
  "data": {
    "export_full_delta": false,
    "include_organization_resources": false
  }
}

Response

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

dataobject

A catalog release represents a collection of hierarchical product data, price books and catalogs rules.

idstring

A unique identifier for the catalog release.

attributesobject5 fields

relationshipsobject3 fields

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.

typestring

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

metaobject13 fields

A release's metadata.

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": "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",
      "price_segmentation_enabled": false
    }
  },
  "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?