Package com.commercetools.api.models.me

Interface MyCartSetShippingMethodAction

All Superinterfaces:

MyCartUpdateAction, ResourceUpdateAction<MyCartUpdateAction>

All Known Implementing Classes:

MyCartSetShippingMethodActionImpl

public interface MyCartSetShippingMethodAction
extends MyCartUpdateAction

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

     MyCartSetShippingMethodAction myCartSetShippingMethodAction = MyCartSetShippingMethodAction.builder()
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static MyCartSetShippingMethodActionBuilder	builder()	builder factory method for MyCartSetShippingMethodAction
static MyCartSetShippingMethodActionBuilder	builder(MyCartSetShippingMethodAction template)	create builder for MyCartSetShippingMethodAction instance
static MyCartSetShippingMethodAction	deepCopy(MyCartSetShippingMethodAction template)	factory method to create a deep copy of MyCartSetShippingMethodAction
@Valid ExternalTaxRateDraft	getExternalTaxRate()	An external Tax Rate can be set if the Cart has the External TaxMode.
@Valid ShippingMethodResourceIdentifier	getShippingMethod()	Value to set.
static MyCartSetShippingMethodAction	of()	factory method
static MyCartSetShippingMethodAction	of(MyCartSetShippingMethodAction template)	factory method to create a shallow copy MyCartSetShippingMethodAction
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<MyCartSetShippingMethodAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMyCartSetShippingMethodAction(Function<MyCartSetShippingMethodAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.me.MyCartUpdateAction

getAction, withMyCartUpdateAction

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

get

Field Details

SET_SHIPPING_METHOD

static final String SET_SHIPPING_METHOD

discriminator value for MyCartSetShippingMethodAction

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 MyCartSetShippingMethodAction of()

factory method

Returns:

instance of MyCartSetShippingMethodAction

of

static MyCartSetShippingMethodAction of(MyCartSetShippingMethodAction template)

factory method to create a shallow copy MyCartSetShippingMethodAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static MyCartSetShippingMethodAction deepCopy(@Nullable
 MyCartSetShippingMethodAction template)

factory method to create a deep copy of MyCartSetShippingMethodAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyCartSetShippingMethodActionBuilder builder()

builder factory method for MyCartSetShippingMethodAction

Returns:

builder

builder

static MyCartSetShippingMethodActionBuilder builder(MyCartSetShippingMethodAction template)

create builder for MyCartSetShippingMethodAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyCartSetShippingMethodAction

default <T> T withMyCartSetShippingMethodAction(Function<MyCartSetShippingMethodAction,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<MyCartSetShippingMethodAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference