Typescript SDK Type Docs
    Preparing search index...

    Interface PublishChange

    Change triggered when:

      - [ProductCatalogData](ctp:api:type:ProductCatalogData) `published` transitions from `false` to `true`.
  - Any update action updates the current catalog (using `staged=false`) and the resulting Product is in a published state.

For better traceability of the [Publish](ctp:api:type:ProductPublishAction) update action, use the [ProductPublished](ctp:api:type:ProductPublishedMessage) Message.
    interface PublishChange {
        change: string;
        type: "PublishChange";
    }

    Hierarchy (View Summary)

    Index

    Properties

    change type

    Properties

    change: string

    Change type on a resource that is similar to the update action it relates to, where possible. It is not a unique identifier for the data structure, for example, the setDescription change can occur with a localized and non-localized representation.

    [Records](ctp:history:type:Record) can be filtered by this value using the `changes` query parameter.
    type: "PublishChange"

    Unique discriminator value to reliably deserialize the data type.

    Settings

    Member Visibility

    On This Page

    Properties