Package com.commercetools.api.models.cart

Interface CartSetShippingMethodAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

All Known Implementing Classes:

CartSetShippingMethodActionImpl

public interface CartSetShippingMethodAction
extends CartUpdateAction

To set the Cart's Shipping Method the Cart must have the Single ShippingMode and a shippingAddress.

Example to create an instance using the builder pattern

     CartSetShippingMethodAction cartSetShippingMethodAction = CartSetShippingMethodAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_SHIPPING_METHOD	discriminator value for CartSetShippingMethodAction

Method Summary

Modifier and Type	Method	Description
static CartSetShippingMethodActionBuilder	builder()	builder factory method for CartSetShippingMethodAction
static CartSetShippingMethodActionBuilder	builder(CartSetShippingMethodAction template)	create builder for CartSetShippingMethodAction instance
static CartSetShippingMethodAction	deepCopy(CartSetShippingMethodAction template)	factory method to create a deep copy of CartSetShippingMethodAction
@Valid ExternalTaxRateDraft	getExternalTaxRate()	An external Tax Rate can be set if the Cart has the External TaxMode.
@Valid ShippingMethodResourceIdentifier	getShippingMethod()	Value to set.
static CartSetShippingMethodAction	of()	factory method
static CartSetShippingMethodAction	of(CartSetShippingMethodAction template)	factory method to create a shallow copy CartSetShippingMethodAction
void	setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)	An external Tax Rate can be set if the Cart has the External TaxMode.
void	setShippingMethod(ShippingMethodResourceIdentifier shippingMethod)	Value to set.
static com.fasterxml.jackson.core.type.TypeReference<CartSetShippingMethodAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartSetShippingMethodAction(Function<CartSetShippingMethodAction,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

SET_SHIPPING_METHOD

static final String SET_SHIPPING_METHOD

discriminator value for CartSetShippingMethodAction

See Also:

• Constant Field Values

Method Details

getShippingMethod

@Valid
@Valid ShippingMethodResourceIdentifier getShippingMethod()

Value to set. If empty, any existing value is removed.

If the referenced Shipping Method has a predicate that does not match the Cart, an InvalidOperation error is returned.

Returns:

shippingMethod

getExternalTaxRate

@Valid
@Valid ExternalTaxRateDraft getExternalTaxRate()

An external Tax Rate can be set if the Cart has the External TaxMode.

Returns:

externalTaxRate

setShippingMethod

void setShippingMethod(ShippingMethodResourceIdentifier shippingMethod)

Value to set. If empty, any existing value is removed.

If the referenced Shipping Method has a predicate that does not match the Cart, an InvalidOperation error is returned.

Parameters:

shippingMethod - value to be set

setExternalTaxRate

void setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)

An external Tax Rate can be set if the Cart has the External TaxMode.

Parameters:

externalTaxRate - value to be set

of

static CartSetShippingMethodAction of()

factory method

Returns:

instance of CartSetShippingMethodAction

of

static CartSetShippingMethodAction of(CartSetShippingMethodAction template)

factory method to create a shallow copy CartSetShippingMethodAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CartSetShippingMethodAction deepCopy(@Nullable
 CartSetShippingMethodAction template)

factory method to create a deep copy of CartSetShippingMethodAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartSetShippingMethodActionBuilder builder()

builder factory method for CartSetShippingMethodAction

Returns:

builder

builder

static CartSetShippingMethodActionBuilder builder(CartSetShippingMethodAction template)

create builder for CartSetShippingMethodAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartSetShippingMethodAction

default <T> T withCartSetShippingMethodAction(Function<CartSetShippingMethodAction,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<CartSetShippingMethodAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference