io.sphere.sdk.carts

Interface CartLike<T>

Type Parameters:

T - the type of this CartLike, order or cart

All Superinterfaces:

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

All Known Subinterfaces:

Cart, Order

public interface CartLike<T>
extends Resource<T>, Custom

Interface to collect the common stuff between carts and orders.

If you want to use this class as abstraction for Cart and Order then use it as CartLike<?>.

Method Summary

Modifier and Type	Method and Description
default javax.money.MonetaryAmount	calculateSubTotalPrice() Returns the subtotal price of the cart, which is calculated by adding the prices of line items and custom line items, thus excluding shipping costs and discounts that are applied to the entire cart.
default Optional<javax.money.MonetaryAmount>	calculateTotalAppliedTaxes() Tries to calculate all the taxes applied to the cart, without discriminating between different tax portions.
default Optional<CustomLineItem>	findCustomLineItem(String customLineItemId) Searches for custom line items by ID of a custom line item.
default Optional<LineItem>	findLineItem(String lineItemId) Searches for line items by ID of a line item.
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.
com.neovisionaries.i18n.CountryCode	getCountry()
default javax.money.CurrencyUnit	getCurrency() The currency of this cart/order.
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 to which this cart/order belongs to.
List<CustomLineItem>	getCustomLineItems() Custom goods, fees or discounts added to the cart.
List<DiscountCodeInfo>	getDiscountCodes() Discount codes belonging to this cart.
List<Address>	getItemShippingAddresses()
List<LineItem>	getLineItems() Snapshots of the products added to the cart.
Locale	getLocale()
CartOrigin	getOrigin()
PaymentInfo	getPaymentInfo() Get associated payments.
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
TaxCalculationMode	getTaxCalculationMode() Tax calculation mode of this cart.
TaxedPrice	getTaxedPrice() The taxed price.
TaxMode	getTaxMode() Tax mode of this cart.
RoundingMode	getTaxRoundingMode() When calculating taxes in taxedPrice, the tax rounding mode is used for decimal values.
javax.money.MonetaryAmount	getTotalPrice()

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

getCreatedAt, getId, getLastModifiedAt, getVersion, toReference

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

of, of

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

hasSameIdAs, toResourceIdentifier

Method Detail

getCustomerId

@Nullable
String getCustomerId()

The ID of the customer to which this cart/order belongs to.

Returns:

id of the customer or null

See Also:

CustomerSignInCommand, SetCustomerId

getCustomerEmail

@Nullable
String getCustomerEmail()

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

Returns:

email

See Also:

SetCustomerEmail

getLineItems

List<LineItem> getLineItems()

Snapshots of the products added to the cart.

Returns:

line items

See Also:

AddLineItem, ChangeLineItemQuantity, RemoveLineItem

getCustomLineItems

List<CustomLineItem> getCustomLineItems()

Custom goods, fees or discounts added to the cart.

Returns:

custom line items

See Also:

AddCustomLineItem, RemoveCustomLineItem

findCustomLineItem

default Optional<CustomLineItem> findCustomLineItem(String customLineItemId)

Searches for custom line items by ID of a custom line item.

Parameters:

customLineItemId - the ID of the custom line item to search for.

Returns:

optional custom line item

findLineItem

default Optional<LineItem> findLineItem(String lineItemId)

Searches for line items by ID of a line item.

Parameters:

lineItemId - the ID of the line item to search for.

Returns:

optional line item

getTotalPrice

javax.money.MonetaryAmount getTotalPrice()

getTaxedPrice

@Nullable
TaxedPrice getTaxedPrice()

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

Returns:

taxed price or null

getShippingAddress

@Nullable
Address getShippingAddress()

Address to ship the goods.

Returns:

address or null

See Also:

SetShippingAddress, getTaxedPrice()

getBillingAddress

@Nullable
Address getBillingAddress()

Address for the bill.

Returns:

address or null

See Also:

SetBillingAddress

getCustomerGroup

@Nullable
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.

Returns:

reference of a customer group or null

getCountry

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

getDiscountCodes

List<DiscountCodeInfo> getDiscountCodes()

Discount codes belonging to this cart.

Returns:

discount codes

See Also:

AddDiscountCode

getCustom

@Nullable
CustomFields getCustom()

Specified by:

getCustom in interface Custom

getShippingInfo

@Nullable
CartShippingInfo getShippingInfo()

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

Returns:

shipping info

See Also:

SetShippingMethod, SetCustomShippingMethod, AddDelivery

getPaymentInfo

@Nullable
PaymentInfo getPaymentInfo()

Get associated payments.

Returns:

payments

See Also:

AddPayment, RemovePayment, AddPayment, RemovePayment

getTaxMode

TaxMode getTaxMode()

Tax mode of this cart.

Returns:

tax mode

See Also:

ChangeTaxMode

getTaxCalculationMode

TaxCalculationMode getTaxCalculationMode()

Tax calculation mode of this cart.

Returns:

TaxCalculationMode

See Also:

ChangeTaxCalculationMode

getCurrency

default javax.money.CurrencyUnit getCurrency()

The currency of this cart/order.

Returns:

currency

getAnonymousId

@Nullable
String getAnonymousId()

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

Returns:

anonymousId

getLocale

@Nullable
Locale getLocale()

getShippingRateInput

@Nullable
ShippingRateInput getShippingRateInput()

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

Returns:

shippingRateInput

getTaxRoundingMode

RoundingMode getTaxRoundingMode()

When calculating taxes in taxedPrice, the tax rounding mode is used for decimal values.

Returns:

the tax rounding mode

getOrigin

CartOrigin getOrigin()

getItemShippingAddresses

List<Address> getItemShippingAddresses()

calculateSubTotalPrice

default javax.money.MonetaryAmount calculateSubTotalPrice()

Returns the subtotal price of the cart, which is calculated by adding the prices of line items and custom line items, thus excluding shipping costs and discounts that are applied to the entire cart.

Returns:

the estimated subtotal price of the cart

calculateTotalAppliedTaxes

default Optional<javax.money.MonetaryAmount> calculateTotalAppliedTaxes()

Tries to calculate all the taxes applied to the cart, without discriminating between different tax portions. Only possible if taxes have already been applied to the cart.

Returns:

the taxes applied to the cart, or absent if taxes have not been applied yet