Package com.commercetools.api.models.order_edit

Interface StagedOrderSetCustomShippingMethodAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

All Known Implementing Classes:

StagedOrderSetCustomShippingMethodActionImpl

public interface StagedOrderSetCustomShippingMethodAction
extends StagedOrderUpdateAction

StagedOrderSetCustomShippingMethodAction 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
static StagedOrderSetCustomShippingMethodAction	deepCopy(StagedOrderSetCustomShippingMethodAction template)	factory method to create a deep copy of StagedOrderSetCustomShippingMethodAction
@Valid ExternalTaxRateDraft	getExternalTaxRate()	Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.
@NotNull String	getShippingMethodName()
@NotNull @Valid ShippingRateDraft	getShippingRate()
@Valid TaxCategoryResourceIdentifier	getTaxCategory()	ResourceIdentifier to a TaxCategory.
static StagedOrderSetCustomShippingMethodAction	of()	factory method
static StagedOrderSetCustomShippingMethodAction	of(StagedOrderSetCustomShippingMethodAction template)	factory method to create a shallow copy StagedOrderSetCustomShippingMethodAction
void	setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)	Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.
void	setShippingMethodName(String shippingMethodName)	set shippingMethodName
void	setShippingRate(ShippingRateDraft shippingRate)	set shippingRate
void	setTaxCategory(TaxCategoryResourceIdentifier taxCategory)	ResourceIdentifier to a TaxCategory.
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()

Returns:

shippingMethodName

getShippingRate

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

Returns:

shippingRate

getTaxCategory

@Valid
@Valid TaxCategoryResourceIdentifier getTaxCategory()

ResourceIdentifier to a TaxCategory.

Returns:

taxCategory

getExternalTaxRate

@Valid
@Valid ExternalTaxRateDraft getExternalTaxRate()

Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.

Returns:

externalTaxRate

setShippingMethodName

void setShippingMethodName(String shippingMethodName)

set shippingMethodName

Parameters:

shippingMethodName - value to be set

setShippingRate

void setShippingRate(ShippingRateDraft shippingRate)

set shippingRate

Parameters:

shippingRate - value to be set

setTaxCategory

void setTaxCategory(TaxCategoryResourceIdentifier taxCategory)

ResourceIdentifier to a TaxCategory.

Parameters:

taxCategory - value to be set

setExternalTaxRate

void setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)

Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.

Parameters:

externalTaxRate - 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

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