Package com.commercetools.api.models.me

Interface MyCartAddItemShippingAddressAction

All Superinterfaces:

MyCartUpdateAction, ResourceUpdateAction<MyCartUpdateAction>

public interface MyCartAddItemShippingAddressAction
extends MyCartUpdateAction

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

     MyCartAddItemShippingAddressAction myCartAddItemShippingAddressAction = MyCartAddItemShippingAddressAction.builder()
             .address(addressBuilder -> addressBuilder)
             .build()
 

Field Summary

Fields

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

Method Summary

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

ADD_ITEM_SHIPPING_ADDRESS

static final String ADD_ITEM_SHIPPING_ADDRESS

discriminator value for MyCartAddItemShippingAddressAction

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

factory method

Returns:

instance of MyCartAddItemShippingAddressAction

of

static MyCartAddItemShippingAddressAction of(MyCartAddItemShippingAddressAction template)

factory method to create a shallow copy MyCartAddItemShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

MyCartAddItemShippingAddressAction copyDeep()

Specified by:

copyDeep in interface MyCartUpdateAction

deepCopy

@Nullable
static MyCartAddItemShippingAddressAction deepCopy(@Nullable
 MyCartAddItemShippingAddressAction template)

factory method to create a deep copy of MyCartAddItemShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyCartAddItemShippingAddressActionBuilder builder()

builder factory method for MyCartAddItemShippingAddressAction

Returns:

builder

builder

static MyCartAddItemShippingAddressActionBuilder builder(MyCartAddItemShippingAddressAction template)

create builder for MyCartAddItemShippingAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyCartAddItemShippingAddressAction

default <T> T withMyCartAddItemShippingAddressAction(Function<MyCartAddItemShippingAddressAction,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<MyCartAddItemShippingAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference