com.shopify.buy3

Class Storefront.CartQuery

java.lang.Object

com.shopify.graphql.support.Query<Storefront.CartQuery>

com.shopify.buy3.Storefront.CartQuery

Enclosing class:

Storefront

public static class Storefront.CartQuery
extends Query<Storefront.CartQuery>

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Storefront.CartQuery.DeliveryGroupsArguments
static interface	Storefront.CartQuery.DeliveryGroupsArgumentsDefinition
class	Storefront.CartQuery.LinesArguments
static interface	Storefront.CartQuery.LinesArgumentsDefinition
class	Storefront.CartQuery.MetafieldArguments
static interface	Storefront.CartQuery.MetafieldArgumentsDefinition

Field Summary

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

_queryBuilder, ALIAS_SUFFIX_SEPARATOR

Method Summary

Modifier and Type	Method and Description
Storefront.CartQuery	appliedGiftCards(Storefront.AppliedGiftCardQueryDefinition queryDef) The gift cards that have been applied to the cart.
Storefront.CartQuery	attribute(java.lang.String key, Storefront.AttributeQueryDefinition queryDef) An attribute associated with the cart.
Storefront.CartQuery	attributes(Storefront.AttributeQueryDefinition queryDef) The attributes associated with the cart.
Storefront.CartQuery	buyerIdentity(Storefront.CartBuyerIdentityQueryDefinition queryDef) Information about the buyer that's interacting with the cart.
Storefront.CartQuery	checkoutUrl() The URL of the checkout for the cart.
Storefront.CartQuery	cost(Storefront.CartCostQueryDefinition queryDef) The estimated costs that the buyer will pay at checkout.
Storefront.CartQuery	createdAt() The date and time when the cart was created.
Storefront.CartQuery	deliveryGroups(Storefront.CartDeliveryGroupConnectionQueryDefinition queryDef) 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.
Storefront.CartQuery	deliveryGroups(Storefront.CartQuery.DeliveryGroupsArgumentsDefinition argsDef, Storefront.CartDeliveryGroupConnectionQueryDefinition queryDef) 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.
Storefront.CartQuery	discountAllocations(Storefront.CartDiscountAllocationQueryDefinition queryDef) The discounts that have been applied to the entire cart.
Storefront.CartQuery	discountCodes(Storefront.CartDiscountCodeQueryDefinition queryDef) The case-insensitive discount codes that the customer added at checkout.
Storefront.CartQuery	estimatedCost(Storefront.CartEstimatedCostQueryDefinition queryDef) Deprecated. Use `cost` instead.
Storefront.CartQuery	lines(Storefront.BaseCartLineConnectionQueryDefinition queryDef) A list of lines containing information about the items the customer intends to purchase.
Storefront.CartQuery	lines(Storefront.CartQuery.LinesArgumentsDefinition argsDef, Storefront.BaseCartLineConnectionQueryDefinition queryDef) A list of lines containing information about the items the customer intends to purchase.
Storefront.CartQuery	metafield(java.lang.String key, Storefront.CartQuery.MetafieldArgumentsDefinition argsDef, Storefront.MetafieldQueryDefinition queryDef) Returns a metafield found by namespace and key.
Storefront.CartQuery	metafield(java.lang.String key, Storefront.MetafieldQueryDefinition queryDef) Returns a metafield found by namespace and key.
Storefront.CartQuery	metafields(java.util.List<Storefront.HasMetafieldsIdentifier> identifiers, Storefront.MetafieldQueryDefinition queryDef) The metafields associated with the resource matching the supplied list of namespaces and keys.
Storefront.CartQuery	note() A note that's associated with the cart.
Storefront.CartQuery	totalQuantity() The total number of items in the cart.
Storefront.CartQuery	updatedAt() The date and time when the cart was updated.

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

appendQuotedString, startField, startInlineFragment, withAlias

Methods inherited from class java.lang.Object

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

Method Detail

appliedGiftCards

public Storefront.CartQuery appliedGiftCards(Storefront.AppliedGiftCardQueryDefinition queryDef)

The gift cards that have been applied to the cart.

attribute

public Storefront.CartQuery attribute(java.lang.String key,
                                      Storefront.AttributeQueryDefinition queryDef)

An attribute associated with the cart.

attributes

public Storefront.CartQuery attributes(Storefront.AttributeQueryDefinition queryDef)

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

buyerIdentity

public Storefront.CartQuery buyerIdentity(Storefront.CartBuyerIdentityQueryDefinition queryDef)

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

checkoutUrl

public Storefront.CartQuery checkoutUrl()

The URL of the checkout for the cart.

cost

public Storefront.CartQuery cost(Storefront.CartCostQueryDefinition queryDef)

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

createdAt

public Storefront.CartQuery createdAt()

The date and time when the cart was created.

deliveryGroups

public Storefront.CartQuery deliveryGroups(Storefront.CartDeliveryGroupConnectionQueryDefinition queryDef)

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.

deliveryGroups

public Storefront.CartQuery deliveryGroups(Storefront.CartQuery.DeliveryGroupsArgumentsDefinition argsDef,
                                           Storefront.CartDeliveryGroupConnectionQueryDefinition queryDef)

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.

discountAllocations

public Storefront.CartQuery discountAllocations(Storefront.CartDiscountAllocationQueryDefinition queryDef)

The discounts that have been applied to the entire cart.

discountCodes

public Storefront.CartQuery discountCodes(Storefront.CartDiscountCodeQueryDefinition queryDef)

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

estimatedCost

@Deprecated
public Storefront.CartQuery estimatedCost(Storefront.CartEstimatedCostQueryDefinition queryDef)

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

lines

public Storefront.CartQuery lines(Storefront.BaseCartLineConnectionQueryDefinition queryDef)

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

lines

public Storefront.CartQuery lines(Storefront.CartQuery.LinesArgumentsDefinition argsDef,
                                  Storefront.BaseCartLineConnectionQueryDefinition queryDef)

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

metafield

public Storefront.CartQuery metafield(java.lang.String key,
                                      Storefront.MetafieldQueryDefinition queryDef)

Returns a metafield found by namespace and key.

metafield

public Storefront.CartQuery metafield(java.lang.String key,
                                      Storefront.CartQuery.MetafieldArgumentsDefinition argsDef,
                                      Storefront.MetafieldQueryDefinition queryDef)

Returns a metafield found by namespace and key.

metafields

public Storefront.CartQuery metafields(java.util.List<Storefront.HasMetafieldsIdentifier> identifiers,
                                       Storefront.MetafieldQueryDefinition queryDef)

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

note

public Storefront.CartQuery note()

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

totalQuantity

public Storefront.CartQuery totalQuantity()

The total number of items in the cart.

updatedAt

public Storefront.CartQuery updatedAt()

The date and time when the cart was updated.