io.sphere.sdk.discountcodes

Interface DiscountCode

All Superinterfaces:

CreationTimestamped, Custom, Identifiable<DiscountCode>, Referenceable<DiscountCode>, Resource<DiscountCode>, ResourceIdentifiable<DiscountCode>, ResourceView<DiscountCode,DiscountCode>, Timestamped, Versioned<DiscountCode>

public interface DiscountCode
extends Resource<DiscountCode>, Custom

Discount codes can be added to a cart to enable certain cart discounts.

See Also:

DiscountCodeCreateCommand, DiscountCodeUpdateCommand, DiscountCodeDeleteCommand, DiscountCodeQuery, DiscountCodeByIdGet, CartDiscount.isRequiringDiscountCode()

Method Summary

Modifier and Type	Method and Description
List<Reference<CartDiscount>>	getCartDiscounts() The referenced matching cart discounts can be applied to the cart once the discount code is added (AddDiscountCode).
String	getCartPredicate() The discount code can only be applied to carts that match this predicate.
String	getCode() Unique identifier of this discount code.
CustomFields	getCustom()
LocalizedString	getDescription() Description of this discount code.
List<String>	getGroups() This field is used to signal to which groups the DiscountCode belongs to.
Long	getMaxApplications() The discount code can only be applied maxApplications times.
Long	getMaxApplicationsPerCustomer() The discount code can only be applied maxApplicationsPerCustomer times per customer.
LocalizedString	getName() Name of this discount code.
List<Reference<com.fasterxml.jackson.databind.JsonNode>>	getReferences() The backend will generate this array from the cartPredicate.
ZonedDateTime	getValidFrom() Start date for discount code validity
ZonedDateTime	getValidUntil() End date for discount code validity
Boolean	isActive() Flag if this cart discount is enabled
static Reference<DiscountCode>	referenceOfId(String id) Creates a reference for one item of this class by a known ID.
static String	referenceTypeId() A type hint for references which resource type is linked in a reference.
static String	resourceTypeId() An identifier for this resource which supports CustomFields.
default Reference<DiscountCode>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<DiscountCode>	typeReference() Creates a container which contains the full Java type information to deserialize this class from JSON.

Methods inherited from interface io.sphere.sdk.models.Resource

getCreatedAt, getId, getLastModifiedAt, getVersion

Methods inherited from interface io.sphere.sdk.models.Versioned

of, of

Methods inherited from interface io.sphere.sdk.models.Referenceable

hasSameIdAs, toResourceIdentifier

Method Detail

getCartDiscounts

List<Reference<CartDiscount>> getCartDiscounts()

The referenced matching cart discounts can be applied to the cart once the discount code is added (AddDiscountCode).

Returns:

cart discounts

See Also:

ChangeCartDiscounts

getCartPredicate

@Nullable
String getCartPredicate()

The discount code can only be applied to carts that match this predicate.

Returns:

predicate or null

See Also:

SetCartPredicate

getCode

String getCode()

Unique identifier of this discount code. This value is added to the cart (AddDiscountCode) to enable the related cart discounts in the cart.

Returns:

code

getGroups

List<String> getGroups()

This field is used to signal to which groups the DiscountCode belongs to.

Returns:

the groups, the discount code belongs to.

getDescription

@Nullable
LocalizedString getDescription()

Description of this discount code.

Returns:

description or null

See Also:

SetDescription

isActive

Boolean isActive()

Flag if this cart discount is enabled

Returns:

true if enabled

See Also:

ChangeIsActive

getValidFrom

@Nullable
ZonedDateTime getValidFrom()

Start date for discount code validity

Returns:

the validity start date

getValidUntil

@Nullable
ZonedDateTime getValidUntil()

End date for discount code validity

Returns:

the validity limit date

getMaxApplications

@Nullable
Long getMaxApplications()

The discount code can only be applied maxApplications times.

Returns:

max applications or null

See Also:

SetMaxApplications

getMaxApplicationsPerCustomer

@Nullable
Long getMaxApplicationsPerCustomer()

The discount code can only be applied maxApplicationsPerCustomer times per customer.

Returns:

max applications or null

See Also:

SetMaxApplicationsPerCustomer

getName

@Nullable
LocalizedString getName()

Name of this discount code.

Returns:

name or null

See Also:

SetName

getReferences

List<Reference<com.fasterxml.jackson.databind.JsonNode>> getReferences()

The backend will generate this array from the cartPredicate. It contains the references of all the resources that are addressed in the predicate.

Returns:

references

getCustom

@Nullable
CustomFields getCustom()

Specified by:

getCustom in interface Custom

toReference

default Reference<DiscountCode> toReference()

Description copied from interface: Referenceable

Creates a reference to this resource, the reference may not be filled.

Specified by:

toReference in interface Referenceable<DiscountCode>

Specified by:

toReference in interface Resource<DiscountCode>

Returns:

reference

referenceTypeId

static String referenceTypeId()

A type hint for references which resource type is linked in a reference.

Returns:

type hint

See Also:

Reference.getTypeId()

typeReference

static com.fasterxml.jackson.core.type.TypeReference<DiscountCode> typeReference()

Creates a container which contains the full Java type information to deserialize this class from JSON.

Returns:

type reference

See Also:

SphereJsonUtils.readObject(byte[], TypeReference), SphereJsonUtils.readObject(String, TypeReference), SphereJsonUtils.readObject(com.fasterxml.jackson.databind.JsonNode, TypeReference), SphereJsonUtils.readObjectFromResource(String, TypeReference)

referenceOfId

static Reference<DiscountCode> referenceOfId(String id)

Creates a reference for one item of this class by a known ID.

An example for categories but this applies for other resources, too:

final String categoryIdFromFormOrSession = "84ac4271-0fec-49d0-9fee-55586c565c58";
final Reference<Category> categoryReference = Category.referenceOfId(categoryIdFromFormOrSession);
assertThat(categoryReference.getId()).isEqualTo(categoryIdFromFormOrSession);
See the test code.

If you already have a resource object, then use toReference() instead:

final Category category = getCategory1();
final Reference<Category> categoryReference = category.toReference();
assertThat(category.getId()).isEqualTo(categoryReference.getId());
See the test code.

Parameters:

id - the ID of the resource which should be referenced.

Returns:

reference

resourceTypeId

static String resourceTypeId()

An identifier for this resource which supports CustomFields.

Returns:

ID of this resource type

See Also:

TypeDraft.getResourceTypeIds(), Custom