Typescript SDK Type Docs
    Preparing search index...

    Interface ProductUnpublishAction

    Sets the published flag on the ProductCatalogData to false. This makes the current representation of a Product unavailable in Product Projection endpoints by default, and excludes it from Product Search. To retrieve unpublished Products on Product Projection endpoints, set parameter staged=true.

    Produces the [ProductUnpublished](ctp:api:type:ProductUnpublishedMessage) Message.
    
    When a Product is unpublished, any associated Line Items already present in a Cart remain unaffected and can still be ordered. To prevent this, do the following:
    
    - If the Product uses Embedded Prices, [remove the Embedded Prices](ctp:api:type:ProductRemovePriceAction) from the unpublished Product.
    - If the Product uses Standalone Prices, [inactivate](ctp:api:type:StandalonePriceChangeActiveAction) or [delete](/projects/standalone-prices#delete-standaloneprice) the Standalone Prices.
    
    interface ProductUnpublishAction {
        action: "unpublish";
    }

    Hierarchy (View Summary)

    Index

    Properties

    Properties

    action: "unpublish"