Package com.commercetools.api.models.order_edit

Interface StagedOrderSetShippingMethodAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderSetShippingMethodAction
extends StagedOrderUpdateAction

To set the Cart's Shipping Method, the Cart must have the Single ShippingMode and a shippingAddress.

Example to create an instance using the builder pattern

     StagedOrderSetShippingMethodAction stagedOrderSetShippingMethodAction = StagedOrderSetShippingMethodAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_SHIPPING_METHOD	discriminator value for StagedOrderSetShippingMethodAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetShippingMethodActionBuilder	builder()	builder factory method for StagedOrderSetShippingMethodAction
static StagedOrderSetShippingMethodActionBuilder	builder(StagedOrderSetShippingMethodAction template)	create builder for StagedOrderSetShippingMethodAction instance
StagedOrderSetShippingMethodAction	copyDeep()
static StagedOrderSetShippingMethodAction	deepCopy(StagedOrderSetShippingMethodAction template)	factory method to create a deep copy of StagedOrderSetShippingMethodAction
@Valid ExternalTaxRateDraft	getExternalTaxRate()	An external Tax Rate can be set if the Cart has the External TaxMode.
@Valid ShippingMethodResourceIdentifier	getShippingMethod()	Value to set.
static StagedOrderSetShippingMethodAction	of()	factory method
static StagedOrderSetShippingMethodAction	of(StagedOrderSetShippingMethodAction template)	factory method to create a shallow copy StagedOrderSetShippingMethodAction
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<StagedOrderSetShippingMethodAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetShippingMethodAction(Function<StagedOrderSetShippingMethodAction,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_METHOD

static final String SET_SHIPPING_METHOD

discriminator value for StagedOrderSetShippingMethodAction

See Also:

• Constant Field Values

Method Details

getShippingMethod

@Valid
@Valid ShippingMethodResourceIdentifier getShippingMethod()

Value to set. If empty, any existing value will be removed. If the referenced Shipping Method has a predicate that does not match the Cart, an InvalidOperation error is returned.

Returns:

shippingMethod

getExternalTaxRate

@Valid
@Valid ExternalTaxRateDraft getExternalTaxRate()

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

Returns:

externalTaxRate

setShippingMethod

void setShippingMethod(ShippingMethodResourceIdentifier shippingMethod)

Value to set. If empty, any existing value will be removed. If the referenced Shipping Method has a predicate that does not match the Cart, an InvalidOperation error is returned.

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

factory method

Returns:

instance of StagedOrderSetShippingMethodAction

of

static StagedOrderSetShippingMethodAction of(StagedOrderSetShippingMethodAction template)

factory method to create a shallow copy StagedOrderSetShippingMethodAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StagedOrderSetShippingMethodAction copyDeep()

Specified by:

copyDeep in interface StagedOrderUpdateAction

deepCopy

@Nullable
static StagedOrderSetShippingMethodAction deepCopy(@Nullable
 StagedOrderSetShippingMethodAction template)

factory method to create a deep copy of StagedOrderSetShippingMethodAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetShippingMethodActionBuilder builder()

builder factory method for StagedOrderSetShippingMethodAction

Returns:

builder

builder

static StagedOrderSetShippingMethodActionBuilder builder(StagedOrderSetShippingMethodAction template)

create builder for StagedOrderSetShippingMethodAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetShippingMethodAction

default <T> T withStagedOrderSetShippingMethodAction(Function<StagedOrderSetShippingMethodAction,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<StagedOrderSetShippingMethodAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference