Package com.commercetools.api.models.order

Interface OrderRemoveItemShippingAddressAction

All Superinterfaces:

OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

public interface OrderRemoveItemShippingAddressAction
extends OrderUpdateAction

An address can only be removed if it is not referenced in any ItemShippingTarget of the Cart. In such case, change the Line Item shipping address to a different addressKey first using the Set LineItemShippingDetails update action, before you remove the obsolete address.

Example to create an instance using the builder pattern

     OrderRemoveItemShippingAddressAction orderRemoveItemShippingAddressAction = OrderRemoveItemShippingAddressAction.builder()
             .addressKey("{addressKey}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_ITEM_SHIPPING_ADDRESS	discriminator value for OrderRemoveItemShippingAddressAction

Method Summary

Modifier and Type	Method	Description
static OrderRemoveItemShippingAddressActionBuilder	builder()	builder factory method for OrderRemoveItemShippingAddressAction
static OrderRemoveItemShippingAddressActionBuilder	builder(OrderRemoveItemShippingAddressAction template)	create builder for OrderRemoveItemShippingAddressAction instance
OrderRemoveItemShippingAddressAction	copyDeep()
static OrderRemoveItemShippingAddressAction	deepCopy(OrderRemoveItemShippingAddressAction template)	factory method to create a deep copy of OrderRemoveItemShippingAddressAction
@NotNull String	getAddressKey()	key of the Address to remove from itemShippingAddresses.
static OrderRemoveItemShippingAddressAction	of()	factory method
static OrderRemoveItemShippingAddressAction	of(OrderRemoveItemShippingAddressAction template)	factory method to create a shallow copy OrderRemoveItemShippingAddressAction
void	setAddressKey(String addressKey)	key of the Address to remove from itemShippingAddresses.
static com.fasterxml.jackson.core.type.TypeReference<OrderRemoveItemShippingAddressAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderRemoveItemShippingAddressAction(Function<OrderRemoveItemShippingAddressAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.order.OrderUpdateAction

getAction, withOrderUpdateAction

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

get

Field Details

REMOVE_ITEM_SHIPPING_ADDRESS

static final String REMOVE_ITEM_SHIPPING_ADDRESS

discriminator value for OrderRemoveItemShippingAddressAction

See Also:

• Constant Field Values

Method Details

getAddressKey

@NotNull
@NotNull String getAddressKey()

key of the Address to remove from itemShippingAddresses.

Returns:

addressKey

setAddressKey

void setAddressKey(String addressKey)

key of the Address to remove from itemShippingAddresses.

Parameters:

addressKey - value to be set

of

static OrderRemoveItemShippingAddressAction of()

factory method

Returns:

instance of OrderRemoveItemShippingAddressAction

of

static OrderRemoveItemShippingAddressAction of(OrderRemoveItemShippingAddressAction template)

factory method to create a shallow copy OrderRemoveItemShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderRemoveItemShippingAddressAction copyDeep()

Specified by:

copyDeep in interface OrderUpdateAction

deepCopy

@Nullable
static OrderRemoveItemShippingAddressAction deepCopy(@Nullable
 OrderRemoveItemShippingAddressAction template)

factory method to create a deep copy of OrderRemoveItemShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderRemoveItemShippingAddressActionBuilder builder()

builder factory method for OrderRemoveItemShippingAddressAction

Returns:

builder

builder

static OrderRemoveItemShippingAddressActionBuilder builder(OrderRemoveItemShippingAddressAction template)

create builder for OrderRemoveItemShippingAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderRemoveItemShippingAddressAction

default <T> T withOrderRemoveItemShippingAddressAction(Function<OrderRemoveItemShippingAddressAction,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<OrderRemoveItemShippingAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference