Package com.commercetools.api.models.me

Interface MyCartAddDiscountCodeAction

All Superinterfaces:

MyCartUpdateAction, ResourceUpdateAction<MyCartUpdateAction>

public interface MyCartAddDiscountCodeAction
extends MyCartUpdateAction

Adds a DiscountCode to the Cart to activate the related CartDiscounts. 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

     MyCartAddDiscountCodeAction myCartAddDiscountCodeAction = MyCartAddDiscountCodeAction.builder()
             .code("{code}")
             .build()
 

Field Summary

Fields

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

Method Summary

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

Methods inherited from interface com.commercetools.api.models.me.MyCartUpdateAction

getAction, withMyCartUpdateAction

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

get

Field Details

ADD_DISCOUNT_CODE

static final String ADD_DISCOUNT_CODE

discriminator value for MyCartAddDiscountCodeAction

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

factory method

Returns:

instance of MyCartAddDiscountCodeAction

of

static MyCartAddDiscountCodeAction of(MyCartAddDiscountCodeAction template)

factory method to create a shallow copy MyCartAddDiscountCodeAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

MyCartAddDiscountCodeAction copyDeep()

Specified by:

copyDeep in interface MyCartUpdateAction

deepCopy

@Nullable
static MyCartAddDiscountCodeAction deepCopy(@Nullable
 MyCartAddDiscountCodeAction template)

factory method to create a deep copy of MyCartAddDiscountCodeAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyCartAddDiscountCodeActionBuilder builder()

builder factory method for MyCartAddDiscountCodeAction

Returns:

builder

builder

static MyCartAddDiscountCodeActionBuilder builder(MyCartAddDiscountCodeAction template)

create builder for MyCartAddDiscountCodeAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyCartAddDiscountCodeAction

default <T> T withMyCartAddDiscountCodeAction(Function<MyCartAddDiscountCodeAction,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<MyCartAddDiscountCodeAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference