Package com.commercetools.api.models.cart

Interface CartRemoveShippingMethodAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

All Known Implementing Classes:

CartRemoveShippingMethodActionImpl

public interface CartRemoveShippingMethodAction
extends CartUpdateAction

Removes a Shipping Method from a Cart that has the Multiple ShippingMode.

Example to create an instance using the builder pattern

     CartRemoveShippingMethodAction cartRemoveShippingMethodAction = CartRemoveShippingMethodAction.builder()
             .shippingKey("{shippingKey}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_SHIPPING_METHOD	discriminator value for CartRemoveShippingMethodAction

Method Summary

Modifier and Type	Method	Description
static CartRemoveShippingMethodActionBuilder	builder()	builder factory method for CartRemoveShippingMethodAction
static CartRemoveShippingMethodActionBuilder	builder(CartRemoveShippingMethodAction template)	create builder for CartRemoveShippingMethodAction instance
static CartRemoveShippingMethodAction	deepCopy(CartRemoveShippingMethodAction template)	factory method to create a deep copy of CartRemoveShippingMethodAction
@NotNull String	getShippingKey()	User-defined unique identifier of the Shipping Method to remove from the Cart.
static CartRemoveShippingMethodAction	of()	factory method
static CartRemoveShippingMethodAction	of(CartRemoveShippingMethodAction template)	factory method to create a shallow copy CartRemoveShippingMethodAction
void	setShippingKey(String shippingKey)	User-defined unique identifier of the Shipping Method to remove from the Cart.
static com.fasterxml.jackson.core.type.TypeReference<CartRemoveShippingMethodAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartRemoveShippingMethodAction(Function<CartRemoveShippingMethodAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.cart.CartUpdateAction

getAction, withCartUpdateAction

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

get

Field Details

REMOVE_SHIPPING_METHOD

static final String REMOVE_SHIPPING_METHOD

discriminator value for CartRemoveShippingMethodAction

See Also:

• Constant Field Values

Method Details

getShippingKey

@NotNull
@NotNull String getShippingKey()

User-defined unique identifier of the Shipping Method to remove from the Cart.

Returns:

shippingKey

setShippingKey

void setShippingKey(String shippingKey)

User-defined unique identifier of the Shipping Method to remove from the Cart.

Parameters:

shippingKey - value to be set

of

static CartRemoveShippingMethodAction of()

factory method

Returns:

instance of CartRemoveShippingMethodAction

of

static CartRemoveShippingMethodAction of(CartRemoveShippingMethodAction template)

factory method to create a shallow copy CartRemoveShippingMethodAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CartRemoveShippingMethodAction deepCopy(@Nullable
 CartRemoveShippingMethodAction template)

factory method to create a deep copy of CartRemoveShippingMethodAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartRemoveShippingMethodActionBuilder builder()

builder factory method for CartRemoveShippingMethodAction

Returns:

builder

builder

static CartRemoveShippingMethodActionBuilder builder(CartRemoveShippingMethodAction template)

create builder for CartRemoveShippingMethodAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartRemoveShippingMethodAction

default <T> T withCartRemoveShippingMethodAction(Function<CartRemoveShippingMethodAction,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<CartRemoveShippingMethodAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference