Package com.commercetools.api.models.order_edit

Interface StagedOrderSetCustomShippingMethodAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderSetCustomShippingMethodAction
extends StagedOrderUpdateAction

To set the Cart's custom Shipping Method (independent of the ShippingMethods managed through the Shipping Methods API) the Cart must have the Single ShippingMode and a shippingAddress.

To unset a custom Shipping Method on a Cart, use the Set ShippingMethod update action without the shippingMethod field instead.

Example to create an instance using the builder pattern

     StagedOrderSetCustomShippingMethodAction stagedOrderSetCustomShippingMethodAction = StagedOrderSetCustomShippingMethodAction.builder()
             .shippingMethodName("{shippingMethodName}")
             .shippingRate(shippingRateBuilder -> shippingRateBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_CUSTOM_SHIPPING_METHOD	discriminator value for StagedOrderSetCustomShippingMethodAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetCustomShippingMethodActionBuilder	builder()	builder factory method for StagedOrderSetCustomShippingMethodAction
static StagedOrderSetCustomShippingMethodActionBuilder	builder(StagedOrderSetCustomShippingMethodAction template)	create builder for StagedOrderSetCustomShippingMethodAction instance
StagedOrderSetCustomShippingMethodAction	copyDeep()
static StagedOrderSetCustomShippingMethodAction	deepCopy(StagedOrderSetCustomShippingMethodAction template)	factory method to create a deep copy of StagedOrderSetCustomShippingMethodAction
@Valid CustomFieldsDraft	getCustom()	Custom Fields for the custom Shipping Method.
@Valid ExternalTaxRateDraft	getExternalTaxRate()	External Tax Rate for the shippingRate to be set if the Cart has the External TaxMode.
@NotNull String	getShippingMethodName()	Name of the custom Shipping Method.
@NotNull @Valid ShippingRateDraft	getShippingRate()	Determines the shipping price.
@Valid TaxCategoryResourceIdentifier	getTaxCategory()	Tax Category used to determine the Tax Rate when the Cart has the Platform TaxMode.
static StagedOrderSetCustomShippingMethodAction	of()	factory method
static StagedOrderSetCustomShippingMethodAction	of(StagedOrderSetCustomShippingMethodAction template)	factory method to create a shallow copy StagedOrderSetCustomShippingMethodAction
void	setCustom(CustomFieldsDraft custom)	Custom Fields for the custom Shipping Method.
void	setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)	External Tax Rate for the shippingRate to be set if the Cart has the External TaxMode.
void	setShippingMethodName(String shippingMethodName)	Name of the custom Shipping Method.
void	setShippingRate(ShippingRateDraft shippingRate)	Determines the shipping price.
void	setTaxCategory(TaxCategoryResourceIdentifier taxCategory)	Tax Category used to determine the Tax Rate when the Cart has the Platform TaxMode.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderSetCustomShippingMethodAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetCustomShippingMethodAction(Function<StagedOrderSetCustomShippingMethodAction,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_CUSTOM_SHIPPING_METHOD

static final String SET_CUSTOM_SHIPPING_METHOD

discriminator value for StagedOrderSetCustomShippingMethodAction

See Also:

• Constant Field Values

Method Details

getShippingMethodName

@NotNull
@NotNull String getShippingMethodName()

Name of the custom Shipping Method.

Returns:

shippingMethodName

getShippingRate

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

Determines the shipping price.

Returns:

shippingRate

getTaxCategory

@Valid
@Valid TaxCategoryResourceIdentifier getTaxCategory()

Tax Category used to determine the Tax Rate when the Cart has the Platform TaxMode.

Returns:

taxCategory

getExternalTaxRate

@Valid
@Valid ExternalTaxRateDraft getExternalTaxRate()

External Tax Rate for the shippingRate to be set if the Cart has the External TaxMode.

Returns:

externalTaxRate

getCustom

@Valid
@Valid CustomFieldsDraft getCustom()

Custom Fields for the custom Shipping Method.

Returns:

custom

setShippingMethodName

void setShippingMethodName(String shippingMethodName)

Name of the custom Shipping Method.

Parameters:

shippingMethodName - value to be set

setShippingRate

void setShippingRate(ShippingRateDraft shippingRate)

Determines the shipping price.

Parameters:

shippingRate - value to be set

setTaxCategory

void setTaxCategory(TaxCategoryResourceIdentifier taxCategory)

Tax Category used to determine the Tax Rate when the Cart has the Platform TaxMode.

Parameters:

taxCategory - value to be set

setExternalTaxRate

void setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)

External Tax Rate for the shippingRate to be set if the Cart has the External TaxMode.

Parameters:

externalTaxRate - value to be set

setCustom

void setCustom(CustomFieldsDraft custom)

Custom Fields for the custom Shipping Method.

Parameters:

custom - value to be set

of

static StagedOrderSetCustomShippingMethodAction of()

factory method

Returns:

instance of StagedOrderSetCustomShippingMethodAction

of

static StagedOrderSetCustomShippingMethodAction of(StagedOrderSetCustomShippingMethodAction template)

factory method to create a shallow copy StagedOrderSetCustomShippingMethodAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StagedOrderSetCustomShippingMethodAction copyDeep()

Specified by:

copyDeep in interface StagedOrderUpdateAction

deepCopy

@Nullable
static StagedOrderSetCustomShippingMethodAction deepCopy(@Nullable
 StagedOrderSetCustomShippingMethodAction template)

factory method to create a deep copy of StagedOrderSetCustomShippingMethodAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetCustomShippingMethodActionBuilder builder()

builder factory method for StagedOrderSetCustomShippingMethodAction

Returns:

builder

builder

static StagedOrderSetCustomShippingMethodActionBuilder builder(StagedOrderSetCustomShippingMethodAction template)

create builder for StagedOrderSetCustomShippingMethodAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetCustomShippingMethodAction

default <T> T withStagedOrderSetCustomShippingMethodAction(Function<StagedOrderSetCustomShippingMethodAction,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<StagedOrderSetCustomShippingMethodAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference