Package com.commercetools.api.models.product

Interface ProductUnpublishAction

All Superinterfaces:

ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>

public interface ProductUnpublishAction
extends ProductUpdateAction

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 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 Summary

Fields

Modifier and Type	Field	Description
static final String	UNPUBLISH	discriminator value for ProductUnpublishAction

Method Summary

Modifier and Type	Method	Description
static ProductUnpublishActionBuilder	builder()	builder factory method for ProductUnpublishAction
static ProductUnpublishActionBuilder	builder(ProductUnpublishAction template)	create builder for ProductUnpublishAction instance
ProductUnpublishAction	copyDeep()
static ProductUnpublishAction	deepCopy(ProductUnpublishAction template)	factory method to create a deep copy of ProductUnpublishAction
static ProductUnpublishAction	of()	factory method
static ProductUnpublishAction	of(ProductUnpublishAction template)	factory method to create a shallow copy ProductUnpublishAction
static com.fasterxml.jackson.core.type.TypeReference<ProductUnpublishAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductUnpublishAction(Function<ProductUnpublishAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.product.ProductUpdateAction

getAction, withProductUpdateAction

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Field Details

UNPUBLISH

static final String UNPUBLISH

discriminator value for ProductUnpublishAction

See Also:

• Constant Field Values

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

copyDeep

ProductUnpublishAction copyDeep()

Specified by:

copyDeep in interface ProductUpdateAction

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