Package com.commercetools.api.models.order_edit

Interface StagedOrderSetShippingAddressAndCustomShippingMethodAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderSetShippingAddressAndCustomShippingMethodAction
extends StagedOrderUpdateAction

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

Example to create an instance using the builder pattern

     StagedOrderSetShippingAddressAndCustomShippingMethodAction stagedOrderSetShippingAddressAndCustomShippingMethodAction = StagedOrderSetShippingAddressAndCustomShippingMethodAction.builder()
             .address(addressBuilder -> addressBuilder)
             .shippingMethodName("{shippingMethodName}")
             .shippingRate(shippingRateBuilder -> shippingRateBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_SHIPPING_ADDRESS_AND_CUSTOM_SHIPPING_METHOD	discriminator value for StagedOrderSetShippingAddressAndCustomShippingMethodAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetShippingAddressAndCustomShippingMethodActionBuilder	builder()	builder factory method for StagedOrderSetShippingAddressAndCustomShippingMethodAction
static StagedOrderSetShippingAddressAndCustomShippingMethodActionBuilder	builder(StagedOrderSetShippingAddressAndCustomShippingMethodAction template)	create builder for StagedOrderSetShippingAddressAndCustomShippingMethodAction instance
static StagedOrderSetShippingAddressAndCustomShippingMethodAction	deepCopy(StagedOrderSetShippingAddressAndCustomShippingMethodAction template)	factory method to create a deep copy of StagedOrderSetShippingAddressAndCustomShippingMethodAction
@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.
@NotNull String	getShippingMethodName()	Value to set.
@NotNull @Valid ShippingRateDraft	getShippingRate()	Value to set.
@Valid TaxCategoryResourceIdentifier	getTaxCategory()	Used to select a Tax Rate when the Order has the Platform TaxMode.
static StagedOrderSetShippingAddressAndCustomShippingMethodAction	of()	factory method
static StagedOrderSetShippingAddressAndCustomShippingMethodAction	of(StagedOrderSetShippingAddressAndCustomShippingMethodAction template)	factory method to create a shallow copy StagedOrderSetShippingAddressAndCustomShippingMethodAction
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	setShippingMethodName(String shippingMethodName)	Value to set.
void	setShippingRate(ShippingRateDraft shippingRate)	Value to set.
void	setTaxCategory(TaxCategoryResourceIdentifier taxCategory)	Used to select a Tax Rate when the Order has the Platform TaxMode.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderSetShippingAddressAndCustomShippingMethodAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetShippingAddressAndCustomShippingMethodAction(Function<StagedOrderSetShippingAddressAndCustomShippingMethodAction,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_CUSTOM_SHIPPING_METHOD

static final String SET_SHIPPING_ADDRESS_AND_CUSTOM_SHIPPING_METHOD

discriminator value for StagedOrderSetShippingAddressAndCustomShippingMethodAction

See Also:

• Constant Field Values

Method Details

getAddress

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

Value to set for shippingAddress.

Returns:

address

getShippingMethodName

@NotNull
@NotNull String getShippingMethodName()

Value to set.

Returns:

shippingMethodName

getShippingRate

@NotNull
@Valid
@NotNull @Valid ShippingRateDraft getShippingRate()

Value to set.

Returns:

shippingRate

getTaxCategory

@Valid
@Valid TaxCategoryResourceIdentifier getTaxCategory()

Used to select a Tax Rate when the Order has the Platform TaxMode.

Returns:

taxCategory

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

setShippingMethodName

void setShippingMethodName(String shippingMethodName)

Value to set.

Parameters:

shippingMethodName - value to be set

setShippingRate

void setShippingRate(ShippingRateDraft shippingRate)

Value to set.

Parameters:

shippingRate - value to be set

setTaxCategory

void setTaxCategory(TaxCategoryResourceIdentifier taxCategory)

Used to select a Tax Rate when the Order has the Platform TaxMode.

Parameters:

taxCategory - 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 StagedOrderSetShippingAddressAndCustomShippingMethodAction of()

factory method

Returns:

instance of StagedOrderSetShippingAddressAndCustomShippingMethodAction

of

static StagedOrderSetShippingAddressAndCustomShippingMethodAction of(StagedOrderSetShippingAddressAndCustomShippingMethodAction template)

factory method to create a shallow copy StagedOrderSetShippingAddressAndCustomShippingMethodAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderSetShippingAddressAndCustomShippingMethodAction deepCopy(@Nullable
 StagedOrderSetShippingAddressAndCustomShippingMethodAction template)

factory method to create a deep copy of StagedOrderSetShippingAddressAndCustomShippingMethodAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetShippingAddressAndCustomShippingMethodActionBuilder builder()

builder factory method for StagedOrderSetShippingAddressAndCustomShippingMethodAction

Returns:

builder

builder

static StagedOrderSetShippingAddressAndCustomShippingMethodActionBuilder builder(StagedOrderSetShippingAddressAndCustomShippingMethodAction template)

create builder for StagedOrderSetShippingAddressAndCustomShippingMethodAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetShippingAddressAndCustomShippingMethodAction

default <T> T withStagedOrderSetShippingAddressAndCustomShippingMethodAction(Function<StagedOrderSetShippingAddressAndCustomShippingMethodAction,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<StagedOrderSetShippingAddressAndCustomShippingMethodAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference