Package com.commercetools.api.models.order

Interface OrderAddItemShippingAddressAction

All Superinterfaces:

OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

public interface OrderAddItemShippingAddressAction
extends OrderUpdateAction

Adds an address to the itemShippingAddresses of an Order. 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

     OrderAddItemShippingAddressAction orderAddItemShippingAddressAction = OrderAddItemShippingAddressAction.builder()
             .address(addressBuilder -> addressBuilder)
             .build()
 

Field Summary

Fields

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

Method Summary

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

ADD_ITEM_SHIPPING_ADDRESS

static final String ADD_ITEM_SHIPPING_ADDRESS

discriminator value for OrderAddItemShippingAddressAction

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 Order.

Returns:

address

setAddress

void setAddress(BaseAddress address)

Address to append to itemShippingAddresses. The new Address must have a key that is unique across this Order.

Parameters:

address - value to be set

of

static OrderAddItemShippingAddressAction of()

factory method

Returns:

instance of OrderAddItemShippingAddressAction

of

static OrderAddItemShippingAddressAction of(OrderAddItemShippingAddressAction template)

factory method to create a shallow copy OrderAddItemShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderAddItemShippingAddressAction copyDeep()

Specified by:

copyDeep in interface OrderUpdateAction

deepCopy

@Nullable
static OrderAddItemShippingAddressAction deepCopy(@Nullable
 OrderAddItemShippingAddressAction template)

factory method to create a deep copy of OrderAddItemShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderAddItemShippingAddressActionBuilder builder()

builder factory method for OrderAddItemShippingAddressAction

Returns:

builder

builder

static OrderAddItemShippingAddressActionBuilder builder(OrderAddItemShippingAddressAction template)

create builder for OrderAddItemShippingAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderAddItemShippingAddressAction

default <T> T withOrderAddItemShippingAddressAction(Function<OrderAddItemShippingAddressAction,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<OrderAddItemShippingAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference