Package com.commercetools.api.models.cart

Interface CartAddDiscountCodeAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

public interface CartAddDiscountCodeAction
extends CartUpdateAction

Adds a DiscountCode to the Cart to activate the related Cart Discounts. If the related Cart Discounts are inactive or invalid, or belong to a different Store than the Cart, a DiscountCodeNonApplicableError is returned.

A Discount Code can be added only if no DirectDiscount has been applied to the Cart. For frozen Carts, the DiscountCodeState must be DoesNotMatchCart when adding a Discount Code.

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

     CartAddDiscountCodeAction cartAddDiscountCodeAction = CartAddDiscountCodeAction.builder()
             .code("{code}")
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static CartAddDiscountCodeActionBuilder	builder()	builder factory method for CartAddDiscountCodeAction
static CartAddDiscountCodeActionBuilder	builder(CartAddDiscountCodeAction template)	create builder for CartAddDiscountCodeAction instance
CartAddDiscountCodeAction	copyDeep()
static CartAddDiscountCodeAction	deepCopy(CartAddDiscountCodeAction template)	factory method to create a deep copy of CartAddDiscountCodeAction
@NotNull String	getCode()	code of a DiscountCode.
static CartAddDiscountCodeAction	of()	factory method
static CartAddDiscountCodeAction	of(CartAddDiscountCodeAction template)	factory method to create a shallow copy CartAddDiscountCodeAction
void	setCode(String code)	code of a DiscountCode.
static com.fasterxml.jackson.core.type.TypeReference<CartAddDiscountCodeAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartAddDiscountCodeAction(Function<CartAddDiscountCodeAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.cart.CartUpdateAction

getAction, withCartUpdateAction

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Field Details

ADD_DISCOUNT_CODE

static final String ADD_DISCOUNT_CODE

discriminator value for CartAddDiscountCodeAction

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

factory method

Returns:

instance of CartAddDiscountCodeAction

of

static CartAddDiscountCodeAction of(CartAddDiscountCodeAction template)

factory method to create a shallow copy CartAddDiscountCodeAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CartAddDiscountCodeAction copyDeep()

Specified by:

copyDeep in interface CartUpdateAction

deepCopy

@Nullable
static CartAddDiscountCodeAction deepCopy(@Nullable
 CartAddDiscountCodeAction template)

factory method to create a deep copy of CartAddDiscountCodeAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartAddDiscountCodeActionBuilder builder()

builder factory method for CartAddDiscountCodeAction

Returns:

builder

builder

static CartAddDiscountCodeActionBuilder builder(CartAddDiscountCodeAction template)

create builder for CartAddDiscountCodeAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartAddDiscountCodeAction

default <T> T withCartAddDiscountCodeAction(Function<CartAddDiscountCodeAction,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<CartAddDiscountCodeAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference