Storefront.CheckoutQuery (buy3 9.0.1 API)

java.lang.Object
- <any>
- - com.shopify.buy3.Storefront.CheckoutQuery

Enclosing class:

Storefront
```
public static class Storefront.CheckoutQuery
extends <any>
```
A container for all the information required to checkout items and pay.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`Storefront.CheckoutQuery.DiscountApplicationsArguments`
`static interface`	`Storefront.CheckoutQuery.DiscountApplicationsArgumentsDefinition`
`class`	`Storefront.CheckoutQuery.LineItemsArguments`
`static interface`	`Storefront.CheckoutQuery.LineItemsArgumentsDefinition`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Storefront.CheckoutQuery`	`appliedGiftCards(Storefront.AppliedGiftCardQueryDefinition queryDef)` The gift cards used on the checkout.
`Storefront.CheckoutQuery`	`availableShippingRates(Storefront.AvailableShippingRatesQueryDefinition queryDef)` The available shipping rates for this Checkout.
`Storefront.CheckoutQuery`	`completedAt()` The date and time when the checkout was completed.
`Storefront.CheckoutQuery`	`createdAt()` The date and time when the checkout was created.
`Storefront.CheckoutQuery`	`currencyCode()` The currency code for the Checkout.
`Storefront.CheckoutQuery`	`customAttributes(Storefront.AttributeQueryDefinition queryDef)` A list of extra information that is added to the checkout.
`Storefront.CheckoutQuery`	`customer(Storefront.CustomerQueryDefinition queryDef)` Deprecated. This field will always return null. If you have an authentication token for the customer, you can use the `customer` field on the query root to retrieve it.
`Storefront.CheckoutQuery`	`discountApplications(Storefront.CheckoutQuery.DiscountApplicationsArgumentsDefinition argsDef, Storefront.DiscountApplicationConnectionQueryDefinition queryDef)` Discounts that have been applied on the checkout.
`Storefront.CheckoutQuery`	`discountApplications(Storefront.DiscountApplicationConnectionQueryDefinition queryDef)` Discounts that have been applied on the checkout.
`Storefront.CheckoutQuery`	`email()` The email attached to this checkout.
`Storefront.CheckoutQuery`	`lineItems(Storefront.CheckoutLineItemConnectionQueryDefinition queryDef)` A list of line item objects, each one containing information about an item in the checkout.
`Storefront.CheckoutQuery`	`lineItems(Storefront.CheckoutQuery.LineItemsArgumentsDefinition argsDef, Storefront.CheckoutLineItemConnectionQueryDefinition queryDef)` A list of line item objects, each one containing information about an item in the checkout.
`Storefront.CheckoutQuery`	`lineItemsSubtotalPrice(Storefront.MoneyV2QueryDefinition queryDef)` The sum of all the prices of all the items in the checkout.
`Storefront.CheckoutQuery`	`note()` The note associated with the checkout.
`Storefront.CheckoutQuery`	`order(Storefront.OrderQueryDefinition queryDef)` The resulting order from a paid checkout.
`Storefront.CheckoutQuery`	`orderStatusUrl()` The Order Status Page for this Checkout, null when checkout is not completed.
`Storefront.CheckoutQuery`	`paymentDue()` Deprecated. Use `paymentDueV2` instead
`Storefront.CheckoutQuery`	`paymentDueV2(Storefront.MoneyV2QueryDefinition queryDef)` The amount left to be paid.
`Storefront.CheckoutQuery`	`ready()` Whether or not the Checkout is ready and can be completed.
`Storefront.CheckoutQuery`	`requiresShipping()` States whether or not the fulfillment requires shipping.
`Storefront.CheckoutQuery`	`shippingAddress(Storefront.MailingAddressQueryDefinition queryDef)` The shipping address to where the line items will be shipped.
`Storefront.CheckoutQuery`	`shippingDiscountAllocations(Storefront.DiscountAllocationQueryDefinition queryDef)` The discounts that have been allocated onto the shipping line by discount applications.
`Storefront.CheckoutQuery`	`shippingLine(Storefront.ShippingRateQueryDefinition queryDef)` Once a shipping rate is selected by the customer it is transitioned to a `shipping_line` object.
`Storefront.CheckoutQuery`	`subtotalPrice()` Deprecated. Use `subtotalPriceV2` instead
`Storefront.CheckoutQuery`	`subtotalPriceV2(Storefront.MoneyV2QueryDefinition queryDef)` Price of the checkout before duties, shipping and taxes.
`Storefront.CheckoutQuery`	`taxesIncluded()` Specifies if taxes are included in the line item and shipping line prices.
`Storefront.CheckoutQuery`	`taxExempt()` Specifies if the Checkout is tax exempt.
`Storefront.CheckoutQuery`	`totalDuties(Storefront.MoneyV2QueryDefinition queryDef)` The sum of all the duties applied to the line items in the checkout.
`Storefront.CheckoutQuery`	`totalPrice()` Deprecated. Use `totalPriceV2` instead
`Storefront.CheckoutQuery`	`totalPriceV2(Storefront.MoneyV2QueryDefinition queryDef)` The sum of all the prices of all the items in the checkout, duties, taxes and discounts included.
`Storefront.CheckoutQuery`	`totalTax()` Deprecated. Use `totalTaxV2` instead
`Storefront.CheckoutQuery`	`totalTaxV2(Storefront.MoneyV2QueryDefinition queryDef)` The sum of all the taxes applied to the line items and shipping lines in the checkout.
`Storefront.CheckoutQuery`	`updatedAt()` The date and time when the checkout was last updated.
`Storefront.CheckoutQuery`	`webUrl()` The url pointing to the checkout accessible from the web.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - appliedGiftCards
```
public Storefront.CheckoutQuery appliedGiftCards(Storefront.AppliedGiftCardQueryDefinition queryDef)
```
    The gift cards used on the checkout.
  - availableShippingRates
```
public Storefront.CheckoutQuery availableShippingRates(Storefront.AvailableShippingRatesQueryDefinition queryDef)
```
    The available shipping rates for this Checkout. Should only be used when checkout `requiresShipping` is `true` and the shipping address is valid.
  - completedAt
```
public Storefront.CheckoutQuery completedAt()
```
    The date and time when the checkout was completed.
  - createdAt
```
public Storefront.CheckoutQuery createdAt()
```
    The date and time when the checkout was created.
  - currencyCode
```
public Storefront.CheckoutQuery currencyCode()
```
    The currency code for the Checkout.
  - customAttributes
```
public Storefront.CheckoutQuery customAttributes(Storefront.AttributeQueryDefinition queryDef)
```
    A list of extra information that is added to the checkout.
  - customer
```
@Deprecated
public Storefront.CheckoutQuery customer(Storefront.CustomerQueryDefinition queryDef)
```
    Deprecated. This field will always return null. If you have an authentication token for the customer, you can use the `customer` field on the query root to retrieve it.
    
    The customer associated with the checkout.
  - discountApplications
```
public Storefront.CheckoutQuery discountApplications(Storefront.DiscountApplicationConnectionQueryDefinition queryDef)
```
    Discounts that have been applied on the checkout.
  - discountApplications
```
public Storefront.CheckoutQuery discountApplications(Storefront.CheckoutQuery.DiscountApplicationsArgumentsDefinition argsDef,
                                                     Storefront.DiscountApplicationConnectionQueryDefinition queryDef)
```
    Discounts that have been applied on the checkout.
  - email
```
public Storefront.CheckoutQuery email()
```
    The email attached to this checkout.
  - lineItems
```
public Storefront.CheckoutQuery lineItems(Storefront.CheckoutLineItemConnectionQueryDefinition queryDef)
```
    A list of line item objects, each one containing information about an item in the checkout.
  - lineItems
```
public Storefront.CheckoutQuery lineItems(Storefront.CheckoutQuery.LineItemsArgumentsDefinition argsDef,
                                          Storefront.CheckoutLineItemConnectionQueryDefinition queryDef)
```
    A list of line item objects, each one containing information about an item in the checkout.
  - lineItemsSubtotalPrice
```
public Storefront.CheckoutQuery lineItemsSubtotalPrice(Storefront.MoneyV2QueryDefinition queryDef)
```
    The sum of all the prices of all the items in the checkout. Duties, taxes, shipping and discounts excluded.
  - note
```
public Storefront.CheckoutQuery note()
```
    The note associated with the checkout.
  - order
```
public Storefront.CheckoutQuery order(Storefront.OrderQueryDefinition queryDef)
```
    The resulting order from a paid checkout.
  - orderStatusUrl
```
public Storefront.CheckoutQuery orderStatusUrl()
```
    The Order Status Page for this Checkout, null when checkout is not completed.
  - paymentDue
```
@Deprecated
public Storefront.CheckoutQuery paymentDue()
```
    Deprecated. Use `paymentDueV2` instead
    
    The amount left to be paid. This is equal to the cost of the line items, taxes and shipping minus discounts and gift cards.
  - paymentDueV2
```
public Storefront.CheckoutQuery paymentDueV2(Storefront.MoneyV2QueryDefinition queryDef)
```
    The amount left to be paid. This is equal to the cost of the line items, duties, taxes and shipping minus discounts and gift cards.
  - ready
```
public Storefront.CheckoutQuery ready()
```
    Whether or not the Checkout is ready and can be completed. Checkouts may have asynchronous operations that can take time to finish. If you want to complete a checkout or ensure all the fields are populated and up to date, polling is required until the value is true.
  - requiresShipping
```
public Storefront.CheckoutQuery requiresShipping()
```
    States whether or not the fulfillment requires shipping.
  - shippingAddress
```
public Storefront.CheckoutQuery shippingAddress(Storefront.MailingAddressQueryDefinition queryDef)
```
    The shipping address to where the line items will be shipped.
  - shippingDiscountAllocations
```
public Storefront.CheckoutQuery shippingDiscountAllocations(Storefront.DiscountAllocationQueryDefinition queryDef)
```
    The discounts that have been allocated onto the shipping line by discount applications.
  - shippingLine
```
public Storefront.CheckoutQuery shippingLine(Storefront.ShippingRateQueryDefinition queryDef)
```
    Once a shipping rate is selected by the customer it is transitioned to a `shipping_line` object.
  - subtotalPrice
```
@Deprecated
public Storefront.CheckoutQuery subtotalPrice()
```
    Deprecated. Use `subtotalPriceV2` instead
    
    Price of the checkout before shipping and taxes.
  - subtotalPriceV2
```
public Storefront.CheckoutQuery subtotalPriceV2(Storefront.MoneyV2QueryDefinition queryDef)
```
    Price of the checkout before duties, shipping and taxes.
  - taxExempt
```
public Storefront.CheckoutQuery taxExempt()
```
    Specifies if the Checkout is tax exempt.
  - taxesIncluded
```
public Storefront.CheckoutQuery taxesIncluded()
```
    Specifies if taxes are included in the line item and shipping line prices.
  - totalDuties
```
public Storefront.CheckoutQuery totalDuties(Storefront.MoneyV2QueryDefinition queryDef)
```
    The sum of all the duties applied to the line items in the checkout.
  - totalPrice
```
@Deprecated
public Storefront.CheckoutQuery totalPrice()
```
    Deprecated. Use `totalPriceV2` instead
    
    The sum of all the prices of all the items in the checkout, taxes and discounts included.
  - totalPriceV2
```
public Storefront.CheckoutQuery totalPriceV2(Storefront.MoneyV2QueryDefinition queryDef)
```
    The sum of all the prices of all the items in the checkout, duties, taxes and discounts included.
  - totalTax
```
@Deprecated
public Storefront.CheckoutQuery totalTax()
```
    Deprecated. Use `totalTaxV2` instead
    
    The sum of all the taxes applied to the line items and shipping lines in the checkout.
  - totalTaxV2
```
public Storefront.CheckoutQuery totalTaxV2(Storefront.MoneyV2QueryDefinition queryDef)
```
    The sum of all the taxes applied to the line items and shipping lines in the checkout.
  - updatedAt
```
public Storefront.CheckoutQuery updatedAt()
```
    The date and time when the checkout was last updated.
  - webUrl
```
public Storefront.CheckoutQuery webUrl()
```
    The url pointing to the checkout accessible from the web.

Class Storefront.CheckoutQuery

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

appliedGiftCards

availableShippingRates

completedAt

createdAt

currencyCode

customAttributes

customer

discountApplications

discountApplications

email

lineItems

lineItems

lineItemsSubtotalPrice

note

order

orderStatusUrl

paymentDue

paymentDueV2

ready

requiresShipping

shippingAddress

shippingDiscountAllocations

shippingLine

subtotalPrice

subtotalPriceV2

taxExempt

taxesIncluded

totalDuties

totalPrice

totalPriceV2

totalTax

totalTaxV2

updatedAt

webUrl