Package com.commercetools.api.models.product

Interface ProductUnpublishAction

All Superinterfaces:
ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>
public interface ProductUnpublishAction extends ProductUpdateAction

Removes the current projection of the Product. The staged projection is unaffected. To retrieve unpublished Products, the staged parameter must be set to false when querying/searching Product Projections. Produces the ProductUnpublished 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 from the unpublished Product.
  • If the Product uses Standalone Prices, inactivate or delete the Standalone Prices.
Example to create an instance using the builder pattern 

     ProductUnpublishAction productUnpublishAction = ProductUnpublishAction.builder()
             .build()

  • Field Details

  • Method Details

    • of

      static ProductUnpublishAction of()
      factory method
      Returns:
      instance of ProductUnpublishAction

    • of

      static ProductUnpublishAction of(ProductUnpublishAction template)
      factory method to create a shallow copy ProductUnpublishAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static ProductUnpublishAction deepCopy(@Nullable ProductUnpublishAction template)
      factory method to create a deep copy of ProductUnpublishAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ProductUnpublishActionBuilder builder()
      builder factory method for ProductUnpublishAction
      Returns:
      builder

    • builder

      static ProductUnpublishActionBuilder builder(ProductUnpublishAction template)
      create builder for ProductUnpublishAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withProductUnpublishAction

      default <T> T withProductUnpublishAction(Function<ProductUnpublishAction,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ProductUnpublishAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference