Package com.commercetools.api.models.order_edit

Interface StagedOrderSetShippingAddressAndShippingMethodAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderSetShippingAddressAndShippingMethodAction
extends StagedOrderUpdateAction

Sets the shipping address and Shipping Method together to prevent an inconsistent state.

Example to create an instance using the builder pattern

     StagedOrderSetShippingAddressAndShippingMethodAction stagedOrderSetShippingAddressAndShippingMethodAction = StagedOrderSetShippingAddressAndShippingMethodAction.builder()
             .address(addressBuilder -> addressBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_SHIPPING_ADDRESS_AND_SHIPPING_METHOD	discriminator value for StagedOrderSetShippingAddressAndShippingMethodAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetShippingAddressAndShippingMethodActionBuilder	builder()	builder factory method for StagedOrderSetShippingAddressAndShippingMethodAction
static StagedOrderSetShippingAddressAndShippingMethodActionBuilder	builder(StagedOrderSetShippingAddressAndShippingMethodAction template)	create builder for StagedOrderSetShippingAddressAndShippingMethodAction instance
static StagedOrderSetShippingAddressAndShippingMethodAction	deepCopy(StagedOrderSetShippingAddressAndShippingMethodAction template)	factory method to create a deep copy of StagedOrderSetShippingAddressAndShippingMethodAction
@NotNull @Valid BaseAddress	getAddress()	Value to set for shippingAddress.
@Valid ExternalTaxRateDraft	getExternalTaxRate()	An external Tax Rate can be set if the Cart has the External TaxMode.
@Valid ShippingMethodResourceIdentifier	getShippingMethod()	Value to set.
static StagedOrderSetShippingAddressAndShippingMethodAction	of()	factory method
static StagedOrderSetShippingAddressAndShippingMethodAction	of(StagedOrderSetShippingAddressAndShippingMethodAction template)	factory method to create a shallow copy StagedOrderSetShippingAddressAndShippingMethodAction
void	setAddress(BaseAddress address)	Value to set for shippingAddress.
void	setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)	An external Tax Rate can be set if the Cart has the External TaxMode.
void	setShippingMethod(ShippingMethodResourceIdentifier shippingMethod)	Value to set.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderSetShippingAddressAndShippingMethodAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetShippingAddressAndShippingMethodAction(Function<StagedOrderSetShippingAddressAndShippingMethodAction,T> helper)	accessor map function

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

get

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

getAction, withStagedOrderUpdateAction

Field Details

SET_SHIPPING_ADDRESS_AND_SHIPPING_METHOD

static final String SET_SHIPPING_ADDRESS_AND_SHIPPING_METHOD

discriminator value for StagedOrderSetShippingAddressAndShippingMethodAction

See Also:

• Constant Field Values

Method Details

getAddress

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

Value to set for shippingAddress.

Returns:

address

getShippingMethod

@Valid
@Valid ShippingMethodResourceIdentifier getShippingMethod()

Value to set.

Returns:

shippingMethod

getExternalTaxRate

@Valid
@Valid ExternalTaxRateDraft getExternalTaxRate()

An external Tax Rate can be set if the Cart has the External TaxMode.

Returns:

externalTaxRate

setAddress

void setAddress(BaseAddress address)

Value to set for shippingAddress.

Parameters:

address - value to be set

setShippingMethod

void setShippingMethod(ShippingMethodResourceIdentifier shippingMethod)

Value to set.

Parameters:

shippingMethod - value to be set

setExternalTaxRate

void setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)

An external Tax Rate can be set if the Cart has the External TaxMode.

Parameters:

externalTaxRate - value to be set

of

static StagedOrderSetShippingAddressAndShippingMethodAction of()

factory method

Returns:

instance of StagedOrderSetShippingAddressAndShippingMethodAction

of

static StagedOrderSetShippingAddressAndShippingMethodAction of(StagedOrderSetShippingAddressAndShippingMethodAction template)

factory method to create a shallow copy StagedOrderSetShippingAddressAndShippingMethodAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderSetShippingAddressAndShippingMethodAction deepCopy(@Nullable
 StagedOrderSetShippingAddressAndShippingMethodAction template)

factory method to create a deep copy of StagedOrderSetShippingAddressAndShippingMethodAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetShippingAddressAndShippingMethodActionBuilder builder()

builder factory method for StagedOrderSetShippingAddressAndShippingMethodAction

Returns:

builder

builder

static StagedOrderSetShippingAddressAndShippingMethodActionBuilder builder(StagedOrderSetShippingAddressAndShippingMethodAction template)

create builder for StagedOrderSetShippingAddressAndShippingMethodAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetShippingAddressAndShippingMethodAction

default <T> T withStagedOrderSetShippingAddressAndShippingMethodAction(Function<StagedOrderSetShippingAddressAndShippingMethodAction,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<StagedOrderSetShippingAddressAndShippingMethodAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference