Package com.commercetools.api.models.order_edit

Interface StagedOrderAddDiscountCodeAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderAddDiscountCodeAction
extends StagedOrderUpdateAction

Adds a DiscountCode to the Cart to activate the related Cart Discounts. Adding a Discount Code is only possible if no DirectDiscount has been applied to the Order.

The maximum number of Discount Codes in a Cart is restricted by a limit.

Specific Error Code: MatchingPriceNotFound

Example to create an instance using the builder pattern

     StagedOrderAddDiscountCodeAction stagedOrderAddDiscountCodeAction = StagedOrderAddDiscountCodeAction.builder()
             .code("{code}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_DISCOUNT_CODE	discriminator value for StagedOrderAddDiscountCodeAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderAddDiscountCodeActionBuilder	builder()	builder factory method for StagedOrderAddDiscountCodeAction
static StagedOrderAddDiscountCodeActionBuilder	builder(StagedOrderAddDiscountCodeAction template)	create builder for StagedOrderAddDiscountCodeAction instance
static StagedOrderAddDiscountCodeAction	deepCopy(StagedOrderAddDiscountCodeAction template)	factory method to create a deep copy of StagedOrderAddDiscountCodeAction
@NotNull String	getCode()	code of a DiscountCode.
static StagedOrderAddDiscountCodeAction	of()	factory method
static StagedOrderAddDiscountCodeAction	of(StagedOrderAddDiscountCodeAction template)	factory method to create a shallow copy StagedOrderAddDiscountCodeAction
void	setCode(String code)	code of a DiscountCode.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderAddDiscountCodeAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderAddDiscountCodeAction(Function<StagedOrderAddDiscountCodeAction,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

ADD_DISCOUNT_CODE

static final String ADD_DISCOUNT_CODE

discriminator value for StagedOrderAddDiscountCodeAction

See Also:

• Constant Field Values

Method Details

getCode

@NotNull
@NotNull String getCode()

code of a DiscountCode.

Returns:

code

setCode

void setCode(String code)

code of a DiscountCode.

Parameters:

code - value to be set

of

static StagedOrderAddDiscountCodeAction of()

factory method

Returns:

instance of StagedOrderAddDiscountCodeAction

of

static StagedOrderAddDiscountCodeAction of(StagedOrderAddDiscountCodeAction template)

factory method to create a shallow copy StagedOrderAddDiscountCodeAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderAddDiscountCodeAction deepCopy(@Nullable
 StagedOrderAddDiscountCodeAction template)

factory method to create a deep copy of StagedOrderAddDiscountCodeAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderAddDiscountCodeActionBuilder builder()

builder factory method for StagedOrderAddDiscountCodeAction

Returns:

builder

builder

static StagedOrderAddDiscountCodeActionBuilder builder(StagedOrderAddDiscountCodeAction template)

create builder for StagedOrderAddDiscountCodeAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderAddDiscountCodeAction

default <T> T withStagedOrderAddDiscountCodeAction(Function<StagedOrderAddDiscountCodeAction,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<StagedOrderAddDiscountCodeAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference