Package com.commercetools.api.models.cart

Interface CartAddItemShippingAddressAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

public interface CartAddItemShippingAddressAction
extends CartUpdateAction

Adds an address to the itemShippingAddresses of a Cart. Use this action when shipping is defined per item. For example, when shipping items to multiple addresses or when using different Shipping Methods, even if all items share the same address.

Example to create an instance using the builder pattern

     CartAddItemShippingAddressAction cartAddItemShippingAddressAction = CartAddItemShippingAddressAction.builder()
             .address(addressBuilder -> addressBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_ITEM_SHIPPING_ADDRESS	discriminator value for CartAddItemShippingAddressAction

Method Summary

Modifier and Type	Method	Description
static CartAddItemShippingAddressActionBuilder	builder()	builder factory method for CartAddItemShippingAddressAction
static CartAddItemShippingAddressActionBuilder	builder(CartAddItemShippingAddressAction template)	create builder for CartAddItemShippingAddressAction instance
CartAddItemShippingAddressAction	copyDeep()
static CartAddItemShippingAddressAction	deepCopy(CartAddItemShippingAddressAction template)	factory method to create a deep copy of CartAddItemShippingAddressAction
@NotNull @Valid BaseAddress	getAddress()	Address to append to itemShippingAddresses.
static CartAddItemShippingAddressAction	of()	factory method
static CartAddItemShippingAddressAction	of(CartAddItemShippingAddressAction template)	factory method to create a shallow copy CartAddItemShippingAddressAction
void	setAddress(BaseAddress address)	Address to append to itemShippingAddresses.
static com.fasterxml.jackson.core.type.TypeReference<CartAddItemShippingAddressAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartAddItemShippingAddressAction(Function<CartAddItemShippingAddressAction,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

ADD_ITEM_SHIPPING_ADDRESS

static final String ADD_ITEM_SHIPPING_ADDRESS

discriminator value for CartAddItemShippingAddressAction

See Also:

• Constant Field Values

Method Details

getAddress

@NotNull
@Valid
@NotNull @Valid BaseAddress getAddress()

Address to append to itemShippingAddresses.

The new Address must have a key that is unique across this Cart.

Returns:

address

setAddress

void setAddress(BaseAddress address)

Address to append to itemShippingAddresses.

The new Address must have a key that is unique across this Cart.

Parameters:

address - value to be set

of

static CartAddItemShippingAddressAction of()

factory method

Returns:

instance of CartAddItemShippingAddressAction

of

static CartAddItemShippingAddressAction of(CartAddItemShippingAddressAction template)

factory method to create a shallow copy CartAddItemShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CartAddItemShippingAddressAction copyDeep()

Specified by:

copyDeep in interface CartUpdateAction

deepCopy

@Nullable
static CartAddItemShippingAddressAction deepCopy(@Nullable
 CartAddItemShippingAddressAction template)

factory method to create a deep copy of CartAddItemShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartAddItemShippingAddressActionBuilder builder()

builder factory method for CartAddItemShippingAddressAction

Returns:

builder

builder

static CartAddItemShippingAddressActionBuilder builder(CartAddItemShippingAddressAction template)

create builder for CartAddItemShippingAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartAddItemShippingAddressAction

default <T> T withCartAddItemShippingAddressAction(Function<CartAddItemShippingAddressAction,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<CartAddItemShippingAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference