Package com.commercetools.api.models.cart

Interface CartSetShippingAddressAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

All Known Implementing Classes:

CartSetShippingAddressActionImpl

public interface CartSetShippingAddressAction
extends CartUpdateAction

Setting the shipping address also sets the TaxRate of Line Items and calculates the TaxedPrice.

If a matching price cannot be found for the given shipping address during Line Item Price selection, a MissingTaxRateForCountry error is returned.

If you want to allow shipping to states inside a country that are not explicitly covered by a TaxRate, set the countryTaxRateFallbackEnabled field to true in the CartsConfiguration by using the Change CountryTaxRateFallbackEnabled update action.

Example to create an instance using the builder pattern

     CartSetShippingAddressAction cartSetShippingAddressAction = CartSetShippingAddressAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_SHIPPING_ADDRESS	discriminator value for CartSetShippingAddressAction

Method Summary

Modifier and Type	Method	Description
static CartSetShippingAddressActionBuilder	builder()	builder factory method for CartSetShippingAddressAction
static CartSetShippingAddressActionBuilder	builder(CartSetShippingAddressAction template)	create builder for CartSetShippingAddressAction instance
static CartSetShippingAddressAction	deepCopy(CartSetShippingAddressAction template)	factory method to create a deep copy of CartSetShippingAddressAction
@Valid BaseAddress	getAddress()	Value to set.
static CartSetShippingAddressAction	of()	factory method
static CartSetShippingAddressAction	of(CartSetShippingAddressAction template)	factory method to create a shallow copy CartSetShippingAddressAction
void	setAddress(BaseAddress address)	Value to set.
static com.fasterxml.jackson.core.type.TypeReference<CartSetShippingAddressAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartSetShippingAddressAction(Function<CartSetShippingAddressAction,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_ADDRESS

static final String SET_SHIPPING_ADDRESS

discriminator value for CartSetShippingAddressAction

See Also:

• Constant Field Values

Method Details

getAddress

@Valid
@Valid BaseAddress getAddress()

Value to set. If not set, the shipping address is unset, and the taxedPrice and taxRate are unset in all Line Items of the Cart.

Returns:

address

setAddress

void setAddress(BaseAddress address)

Value to set. If not set, the shipping address is unset, and the taxedPrice and taxRate are unset in all Line Items of the Cart.

Parameters:

address - value to be set

of

static CartSetShippingAddressAction of()

factory method

Returns:

instance of CartSetShippingAddressAction

of

static CartSetShippingAddressAction of(CartSetShippingAddressAction template)

factory method to create a shallow copy CartSetShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CartSetShippingAddressAction deepCopy(@Nullable
 CartSetShippingAddressAction template)

factory method to create a deep copy of CartSetShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartSetShippingAddressActionBuilder builder()

builder factory method for CartSetShippingAddressAction

Returns:

builder

builder

static CartSetShippingAddressActionBuilder builder(CartSetShippingAddressAction template)

create builder for CartSetShippingAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartSetShippingAddressAction

default <T> T withCartSetShippingAddressAction(Function<CartSetShippingAddressAction,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<CartSetShippingAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference