com.shopify.buy3

Class Storefront.Cart

java.lang.Object

com.shopify.graphql.support.AbstractResponse<Storefront.Cart>

com.shopify.buy3.Storefront.Cart

All Implemented Interfaces:

Storefront.HasMetafields, Storefront.MetafieldParentResource, Storefront.Node, Node, java.io.Serializable

Enclosing class:

Storefront

public static class Storefront.Cart
extends AbstractResponse<Storefront.Cart>
implements Storefront.HasMetafields, Storefront.MetafieldParentResource, Storefront.Node

A cart represents the merchandise that a buyer intends to purchase, and the estimated cost associated with the cart. Learn how to [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) during a customer's session.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.shopify.graphql.support.AbstractResponse

optimisticData, responseData

Constructor Summary

Constructors

Constructor and Description
Cart()
Cart(JsonObject fields)

Method Summary

Modifier and Type	Method and Description
java.util.List<Storefront.AppliedGiftCard>	getAppliedGiftCards() The gift cards that have been applied to the cart.
Storefront.Attribute	getAttribute() An attribute associated with the cart.
java.util.List<Storefront.Attribute>	getAttributes() The attributes associated with the cart.
Storefront.CartBuyerIdentity	getBuyerIdentity() Information about the buyer that's interacting with the cart.
java.lang.String	getCheckoutUrl() The URL of the checkout for the cart.
Storefront.CartCost	getCost() The estimated costs that the buyer will pay at checkout.
DateTime	getCreatedAt() The date and time when the cart was created.
Storefront.CartDeliveryGroupConnection	getDeliveryGroups() The delivery groups available for the cart, based on the buyer identity default delivery address preference or the default address of the logged-in customer.
java.util.List<Storefront.CartDiscountAllocation>	getDiscountAllocations() The discounts that have been applied to the entire cart.
java.util.List<Storefront.CartDiscountCode>	getDiscountCodes() The case-insensitive discount codes that the customer added at checkout.
Storefront.CartEstimatedCost	getEstimatedCost() Deprecated. Use `cost` instead.
java.lang.String	getGraphQlTypeName()
ID	getId() A globally-unique ID.
Storefront.BaseCartLineConnection	getLines() A list of lines containing information about the items the customer intends to purchase.
Storefront.Metafield	getMetafield() Returns a metafield found by namespace and key.
java.util.List<Storefront.Metafield>	getMetafields() The metafields associated with the resource matching the supplied list of namespaces and keys.
java.lang.String	getNote() A note that's associated with the cart.
java.lang.Integer	getTotalQuantity() The total number of items in the cart.
DateTime	getUpdatedAt() The date and time when the cart was updated.
Storefront.Cart	setAppliedGiftCards(java.util.List<Storefront.AppliedGiftCard> arg)
Storefront.Cart	setAttribute(Storefront.Attribute arg)
Storefront.Cart	setAttributes(java.util.List<Storefront.Attribute> arg)
Storefront.Cart	setBuyerIdentity(Storefront.CartBuyerIdentity arg)
Storefront.Cart	setCheckoutUrl(java.lang.String arg)
Storefront.Cart	setCost(Storefront.CartCost arg)
Storefront.Cart	setCreatedAt(DateTime arg)
Storefront.Cart	setDeliveryGroups(Storefront.CartDeliveryGroupConnection arg)
Storefront.Cart	setDiscountAllocations(java.util.List<Storefront.CartDiscountAllocation> arg)
Storefront.Cart	setDiscountCodes(java.util.List<Storefront.CartDiscountCode> arg)
Storefront.Cart	setEstimatedCost(Storefront.CartEstimatedCost arg)
Storefront.Cart	setLines(Storefront.BaseCartLineConnection arg)
Storefront.Cart	setMetafield(Storefront.Metafield arg)
Storefront.Cart	setMetafields(java.util.List<Storefront.Metafield> arg)
Storefront.Cart	setNote(java.lang.String arg)
Storefront.Cart	setTotalQuantity(java.lang.Integer arg)
Storefront.Cart	setUpdatedAt(DateTime arg)
boolean	unwrapsToObject(java.lang.String key)

Methods inherited from class com.shopify.graphql.support.AbstractResponse

collectNodes, get, getFieldName, getKey, jsonAsArray, jsonAsBoolean, jsonAsDouble, jsonAsInteger, jsonAsObject, jsonAsString, withAlias

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Cart

public Cart()

Cart

public Cart(JsonObject fields)
     throws SchemaViolationError

Throws:

SchemaViolationError

Method Detail

getGraphQlTypeName

public java.lang.String getGraphQlTypeName()

Specified by:

getGraphQlTypeName in interface Storefront.HasMetafields

Specified by:

getGraphQlTypeName in interface Storefront.MetafieldParentResource

Specified by:

getGraphQlTypeName in interface Storefront.Node

Specified by:

getGraphQlTypeName in interface Node

getAppliedGiftCards

public java.util.List<Storefront.AppliedGiftCard> getAppliedGiftCards()

The gift cards that have been applied to the cart.

setAppliedGiftCards

public Storefront.Cart setAppliedGiftCards(java.util.List<Storefront.AppliedGiftCard> arg)

getAttribute

public Storefront.Attribute getAttribute()

An attribute associated with the cart.

setAttribute

public Storefront.Cart setAttribute(Storefront.Attribute arg)

getAttributes

public java.util.List<Storefront.Attribute> getAttributes()

The attributes associated with the cart. Attributes are represented as key-value pairs.

setAttributes

public Storefront.Cart setAttributes(java.util.List<Storefront.Attribute> arg)

getBuyerIdentity

public Storefront.CartBuyerIdentity getBuyerIdentity()

Information about the buyer that's interacting with the cart.

setBuyerIdentity

public Storefront.Cart setBuyerIdentity(Storefront.CartBuyerIdentity arg)

getCheckoutUrl

public java.lang.String getCheckoutUrl()

The URL of the checkout for the cart.

setCheckoutUrl

public Storefront.Cart setCheckoutUrl(java.lang.String arg)

getCost

public Storefront.CartCost getCost()

The estimated costs that the buyer will pay at checkout. The costs are subject to change and changes will be reflected at checkout. The `cost` field uses the `buyerIdentity` field to determine [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing).

setCost

public Storefront.Cart setCost(Storefront.CartCost arg)

getCreatedAt

public DateTime getCreatedAt()

The date and time when the cart was created.

setCreatedAt

public Storefront.Cart setCreatedAt(DateTime arg)

getDeliveryGroups

public Storefront.CartDeliveryGroupConnection getDeliveryGroups()

The delivery groups available for the cart, based on the buyer identity default delivery address preference or the default address of the logged-in customer.

setDeliveryGroups

public Storefront.Cart setDeliveryGroups(Storefront.CartDeliveryGroupConnection arg)

getDiscountAllocations

public java.util.List<Storefront.CartDiscountAllocation> getDiscountAllocations()

The discounts that have been applied to the entire cart.

setDiscountAllocations

public Storefront.Cart setDiscountAllocations(java.util.List<Storefront.CartDiscountAllocation> arg)

getDiscountCodes

public java.util.List<Storefront.CartDiscountCode> getDiscountCodes()

The case-insensitive discount codes that the customer added at checkout.

setDiscountCodes

public Storefront.Cart setDiscountCodes(java.util.List<Storefront.CartDiscountCode> arg)

getEstimatedCost

public Storefront.CartEstimatedCost getEstimatedCost()

Deprecated. Use `cost` instead.

The estimated costs that the buyer will pay at checkout. The estimated costs are subject to change and changes will be reflected at checkout. The `estimatedCost` field uses the `buyerIdentity` field to determine [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing).

setEstimatedCost

public Storefront.Cart setEstimatedCost(Storefront.CartEstimatedCost arg)

getId

public ID getId()

A globally-unique ID.

Specified by:

getId in interface Storefront.Node

Specified by:

getId in interface Node

getLines

public Storefront.BaseCartLineConnection getLines()

A list of lines containing information about the items the customer intends to purchase.

setLines

public Storefront.Cart setLines(Storefront.BaseCartLineConnection arg)

getMetafield

public Storefront.Metafield getMetafield()

Returns a metafield found by namespace and key.

Specified by:

getMetafield in interface Storefront.HasMetafields

setMetafield

public Storefront.Cart setMetafield(Storefront.Metafield arg)

getMetafields

public java.util.List<Storefront.Metafield> getMetafields()

The metafields associated with the resource matching the supplied list of namespaces and keys.

Specified by:

getMetafields in interface Storefront.HasMetafields

setMetafields

public Storefront.Cart setMetafields(java.util.List<Storefront.Metafield> arg)

getNote

public java.lang.String getNote()

A note that's associated with the cart. For example, the note can be a personalized message to the buyer.

setNote

public Storefront.Cart setNote(java.lang.String arg)

getTotalQuantity

public java.lang.Integer getTotalQuantity()

The total number of items in the cart.

setTotalQuantity

public Storefront.Cart setTotalQuantity(java.lang.Integer arg)

getUpdatedAt

public DateTime getUpdatedAt()

The date and time when the cart was updated.

setUpdatedAt

public Storefront.Cart setUpdatedAt(DateTime arg)

unwrapsToObject

public boolean unwrapsToObject(java.lang.String key)

Specified by:

unwrapsToObject in class AbstractResponse<Storefront.Cart>