io.sphere.sdk.carts

Interface Cart

All Superinterfaces:

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

public interface Cart
extends CartLike<Cart>

A shopping cart holds product variants and can be ordered.

Each cart either belongs to a registered customer or is an anonymous cart (getCustomerId() yields null).

A cart can have custom fields.

See Also:

CartCreateCommand, CartUpdateCommand, CartDeleteCommand, OrderFromCartCreateCommand, CartQuery, CartByCustomerIdGet, CartByIdGet, Order, Order.getCart()

Method Summary

Modifier and Type	Method and Description
String	getAnonymousId() Identifies carts and orders belonging to an anonymous session (the customer has not signed up/in yet).
Address	getBillingAddress() Address for the bill.
CartState	getCartState() State in the perspective if the cart is active, merged with another cart or ordered.
com.neovisionaries.i18n.CountryCode	getCountry()
CustomFields	getCustom()
String	getCustomerEmail() The email of the customer which should be used for this cart/order.
Reference<CustomerGroup>	getCustomerGroup() In the order context the customer group can only be expanded if the customer was in a group before creating the order.
String	getCustomerId() The id of the customer possessing the cart.
List<CustomLineItem>	getCustomLineItems() The custom line items of this cart.
Integer	getDeleteDaysAfterLastModification()
List<DiscountCodeInfo>	getDiscountCodes() Discount codes belonging to this cart.
InventoryMode	getInventoryMode()
List<Address>	getItemShippingAddresses()
String	getKey()
List<LineItem>	getLineItems() Snapshots of the products added to the cart.
CartOrigin	getOrigin()
PaymentInfo	getPaymentInfo() Get associated payments.
List<Reference<CartDiscount>>	getRefusedGifts() The refused gifts of this cart.
Address	getShippingAddress() Address to ship the goods.
CartShippingInfo	getShippingInfo() Information about shipping set by the backend once the shipping method is set.
ShippingRateInput	getShippingRateInput() The shippingRateInput is used as an input to select a shipping rate price tier
KeyReference<Store>	getStore()
TaxCalculationMode	getTaxCalculationMode() Tax calculation mode of this cart.
TaxedPrice	getTaxedPrice() The taxed price.
javax.money.MonetaryAmount	getTotalPrice()
static Reference<Cart>	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<Cart>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<Cart>	typeReference() Creates a container which contains the full Java type information to deserialize this class from JSON.

Methods inherited from interface io.sphere.sdk.carts.CartLike

calculateSubTotalPrice, calculateTotalAppliedTaxes, findCustomLineItem, findLineItem, getCurrency, getLocale, getTaxMode, getTaxRoundingMode

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

resourceTypeId

static String resourceTypeId()

An identifier for this resource which supports CustomFields.

Returns:

ID of this resource type

See Also:

TypeDraft.getResourceTypeIds(), Custom

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<Cart> 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)

toReference

default Reference<Cart> toReference()

Description copied from interface: Referenceable

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

Specified by:

toReference in interface Referenceable<Cart>

Specified by:

toReference in interface Resource<Cart>

Returns:

reference

getKey

@Nullable
String getKey()

getAnonymousId

@Nullable
String getAnonymousId()

Description copied from interface: CartLike

Identifies carts and orders belonging to an anonymous session (the customer has not signed up/in yet).

Specified by:

getAnonymousId in interface CartLike<Cart>

Returns:

anonymousId

getCartState

CartState getCartState()

State in the perspective if the cart is active, merged with another cart or ordered.

Returns:

state

See Also:

CustomerSignInCommand, OrderFromCartCreateCommand

getInventoryMode

InventoryMode getInventoryMode()

getShippingInfo

@Nullable
CartShippingInfo getShippingInfo()

Description copied from interface: CartLike

Information about shipping set by the backend once the shipping method is set.

Specified by:

getShippingInfo in interface CartLike<Cart>

Returns:

shipping info

See Also:

SetShippingMethod, SetCustomShippingMethod, AddDelivery

getBillingAddress

@Nullable
Address getBillingAddress()

Description copied from interface: CartLike

Address for the bill.

Specified by:

getBillingAddress in interface CartLike<Cart>

Returns:

address or null

See Also:

SetBillingAddress

getCountry

@Nullable
com.neovisionaries.i18n.CountryCode getCountry()

Specified by:

getCountry in interface CartLike<Cart>

getCustomerEmail

@Nullable
String getCustomerEmail()

Description copied from interface: CartLike

The email of the customer which should be used for this cart/order. It can differ from Customer.getEmail().

Specified by:

getCustomerEmail in interface CartLike<Cart>

Returns:

email

See Also:

SetCustomerEmail

getCustomerGroup

@Nullable
Reference<CustomerGroup> getCustomerGroup()

Description copied from interface: CartLike

In the order context the customer group can only be expanded if the customer was in a group before creating the order.

Specified by:

getCustomerGroup in interface CartLike<Cart>

Returns:

reference of a customer group or null

getCustomerId

@Nullable
String getCustomerId()

The id of the customer possessing the cart. Can be null so it is then an anonymous cart.

Specified by:

getCustomerId in interface CartLike<Cart>

Returns:

the id of the corresponding customer or null

See Also:

CustomerSignInCommand, SetCustomerId

getCustomLineItems

List<CustomLineItem> getCustomLineItems()

The custom line items of this cart.

Specified by:

getCustomLineItems in interface CartLike<Cart>

Returns:

custom line items

See Also:

AddCustomLineItem, RemoveCustomLineItem, Order.getCustomLineItems()

getLineItems

List<LineItem> getLineItems()

Description copied from interface: CartLike

Snapshots of the products added to the cart.

Specified by:

getLineItems in interface CartLike<Cart>

Returns:

line items

See Also:

AddLineItem, ChangeLineItemQuantity, RemoveLineItem

getShippingAddress

@Nullable
Address getShippingAddress()

Description copied from interface: CartLike

Address to ship the goods.

Specified by:

getShippingAddress in interface CartLike<Cart>

Returns:

address or null

See Also:

SetShippingAddress, CartLike.getTaxedPrice()

getTaxedPrice

@Nullable
TaxedPrice getTaxedPrice()

Description copied from interface: CartLike

The taxed price. The shipping address (CartLike.getShippingAddress()) is used to determine tax rate of the line items.

Specified by:

getTaxedPrice in interface CartLike<Cart>

Returns:

taxed price or null

getTaxCalculationMode

TaxCalculationMode getTaxCalculationMode()

Description copied from interface: CartLike

Tax calculation mode of this cart.

Specified by:

getTaxCalculationMode in interface CartLike<Cart>

Returns:

TaxCalculationMode

See Also:

ChangeTaxCalculationMode

getTotalPrice

javax.money.MonetaryAmount getTotalPrice()

Specified by:

getTotalPrice in interface CartLike<Cart>

getDiscountCodes

List<DiscountCodeInfo> getDiscountCodes()

Description copied from interface: CartLike

Discount codes belonging to this cart.

Specified by:

getDiscountCodes in interface CartLike<Cart>

Returns:

discount codes

See Also:

AddDiscountCode

getCustom

@Nullable
CustomFields getCustom()

Specified by:

getCustom in interface CartLike<Cart>

Specified by:

getCustom in interface Custom

getPaymentInfo

@Nullable
PaymentInfo getPaymentInfo()

Description copied from interface: CartLike

Get associated payments.

Specified by:

getPaymentInfo in interface CartLike<Cart>

Returns:

payments

See Also:

AddPayment, RemovePayment, AddPayment, RemovePayment

getDeleteDaysAfterLastModification

@Nullable
Integer getDeleteDaysAfterLastModification()

getRefusedGifts

@Nullable
List<Reference<CartDiscount>> getRefusedGifts()

The refused gifts of this cart. Automatically filled when a line item with LineItemMode.GIFT_LINE_ITEM is removed from this cart.

Returns:

the refused gifts of this cart

getShippingRateInput

@Nullable
ShippingRateInput getShippingRateInput()

The shippingRateInput is used as an input to select a shipping rate price tier

Specified by:

getShippingRateInput in interface CartLike<Cart>

Returns:

shippingRateInput

getOrigin

CartOrigin getOrigin()

Specified by:

getOrigin in interface CartLike<Cart>

getItemShippingAddresses

List<Address> getItemShippingAddresses()

Specified by:

getItemShippingAddresses in interface CartLike<Cart>

Returns:

addresses for orders with multiple shipping addresses.

getStore

@Nullable
KeyReference<Store> getStore()

referenceOfId

static Reference<Cart> 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