com.shopify.buy3

Class Storefront.Checkout

java.lang.Object

<any>

com.shopify.buy3.Storefront.Checkout

All Implemented Interfaces:

Storefront.Node

Enclosing class:

Storefront

public static class Storefront.Checkout
extends <any>
implements Storefront.Node

A container for all the information required to checkout items and pay.

Constructor Summary

Constructors

Constructor and Description
Checkout()
Checkout(ID id)
Checkout(JsonObject fields)

Method Summary

Modifier and Type	Method and Description
java.util.List<Storefront.AppliedGiftCard>	getAppliedGiftCards() The gift cards used on the checkout.
Storefront.AvailableShippingRates	getAvailableShippingRates() The available shipping rates for this Checkout.
DateTime	getCompletedAt() The date and time when the checkout was completed.
DateTime	getCreatedAt() The date and time when the checkout was created.
Storefront.CurrencyCode	getCurrencyCode() The currency code for the Checkout.
java.util.List<Storefront.Attribute>	getCustomAttributes() A list of extra information that is added to the checkout.
Storefront.Customer	getCustomer() 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.DiscountApplicationConnection	getDiscountApplications() Discounts that have been applied on the checkout.
java.lang.String	getEmail() The email attached to this checkout.
java.lang.String	getGraphQlTypeName()
ID	getId() Globally unique identifier.
Storefront.CheckoutLineItemConnection	getLineItems() A list of line item objects, each one containing information about an item in the checkout.
Storefront.MoneyV2	getLineItemsSubtotalPrice() The sum of all the prices of all the items in the checkout.
java.lang.String	getNote() The note associated with the checkout.
Storefront.Order	getOrder() The resulting order from a paid checkout.
java.lang.String	getOrderStatusUrl() The Order Status Page for this Checkout, null when checkout is not completed.
java.math.BigDecimal	getPaymentDue() Deprecated. Use `paymentDueV2` instead
Storefront.MoneyV2	getPaymentDueV2() The amount left to be paid.
java.lang.Boolean	getReady() Whether or not the Checkout is ready and can be completed.
java.lang.Boolean	getRequiresShipping() States whether or not the fulfillment requires shipping.
Storefront.MailingAddress	getShippingAddress() The shipping address to where the line items will be shipped.
java.util.List<Storefront.DiscountAllocation>	getShippingDiscountAllocations() The discounts that have been allocated onto the shipping line by discount applications.
Storefront.ShippingRate	getShippingLine() Once a shipping rate is selected by the customer it is transitioned to a `shipping_line` object.
java.math.BigDecimal	getSubtotalPrice() Deprecated. Use `subtotalPriceV2` instead
Storefront.MoneyV2	getSubtotalPriceV2() Price of the checkout before duties, shipping and taxes.
java.lang.Boolean	getTaxesIncluded() Specifies if taxes are included in the line item and shipping line prices.
java.lang.Boolean	getTaxExempt() Specifies if the Checkout is tax exempt.
Storefront.MoneyV2	getTotalDuties() The sum of all the duties applied to the line items in the checkout.
java.math.BigDecimal	getTotalPrice() Deprecated. Use `totalPriceV2` instead
Storefront.MoneyV2	getTotalPriceV2() The sum of all the prices of all the items in the checkout, duties, taxes and discounts included.
java.math.BigDecimal	getTotalTax() Deprecated. Use `totalTaxV2` instead
Storefront.MoneyV2	getTotalTaxV2() The sum of all the taxes applied to the line items and shipping lines in the checkout.
DateTime	getUpdatedAt() The date and time when the checkout was last updated.
java.lang.String	getWebUrl() The url pointing to the checkout accessible from the web.
Storefront.Checkout	setAppliedGiftCards(java.util.List<Storefront.AppliedGiftCard> arg)
Storefront.Checkout	setAvailableShippingRates(Storefront.AvailableShippingRates arg)
Storefront.Checkout	setCompletedAt(DateTime arg)
Storefront.Checkout	setCreatedAt(DateTime arg)
Storefront.Checkout	setCurrencyCode(Storefront.CurrencyCode arg)
Storefront.Checkout	setCustomAttributes(java.util.List<Storefront.Attribute> arg)
Storefront.Checkout	setCustomer(Storefront.Customer arg)
Storefront.Checkout	setDiscountApplications(Storefront.DiscountApplicationConnection arg)
Storefront.Checkout	setEmail(java.lang.String arg)
Storefront.Checkout	setLineItems(Storefront.CheckoutLineItemConnection arg)
Storefront.Checkout	setLineItemsSubtotalPrice(Storefront.MoneyV2 arg)
Storefront.Checkout	setNote(java.lang.String arg)
Storefront.Checkout	setOrder(Storefront.Order arg)
Storefront.Checkout	setOrderStatusUrl(java.lang.String arg)
Storefront.Checkout	setPaymentDue(java.math.BigDecimal arg)
Storefront.Checkout	setPaymentDueV2(Storefront.MoneyV2 arg)
Storefront.Checkout	setReady(java.lang.Boolean arg)
Storefront.Checkout	setRequiresShipping(java.lang.Boolean arg)
Storefront.Checkout	setShippingAddress(Storefront.MailingAddress arg)
Storefront.Checkout	setShippingDiscountAllocations(java.util.List<Storefront.DiscountAllocation> arg)
Storefront.Checkout	setShippingLine(Storefront.ShippingRate arg)
Storefront.Checkout	setSubtotalPrice(java.math.BigDecimal arg)
Storefront.Checkout	setSubtotalPriceV2(Storefront.MoneyV2 arg)
Storefront.Checkout	setTaxesIncluded(java.lang.Boolean arg)
Storefront.Checkout	setTaxExempt(java.lang.Boolean arg)
Storefront.Checkout	setTotalDuties(Storefront.MoneyV2 arg)
Storefront.Checkout	setTotalPrice(java.math.BigDecimal arg)
Storefront.Checkout	setTotalPriceV2(Storefront.MoneyV2 arg)
Storefront.Checkout	setTotalTax(java.math.BigDecimal arg)
Storefront.Checkout	setTotalTaxV2(Storefront.MoneyV2 arg)
Storefront.Checkout	setUpdatedAt(DateTime arg)
Storefront.Checkout	setWebUrl(java.lang.String arg)
boolean	unwrapsToObject(java.lang.String key)

Methods inherited from class java.lang.Object

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

Constructor Detail

Checkout

public Checkout()

Checkout

public Checkout(JsonObject fields)
         throws SchemaViolationError

Throws:

SchemaViolationError

Checkout

public Checkout(ID id)

Method Detail

getGraphQlTypeName

public java.lang.String getGraphQlTypeName()

Specified by:

getGraphQlTypeName in interface Storefront.Node

getAppliedGiftCards

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

The gift cards used on the checkout.

setAppliedGiftCards

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

getAvailableShippingRates

public Storefront.AvailableShippingRates getAvailableShippingRates()

The available shipping rates for this Checkout. Should only be used when checkout `requiresShipping` is `true` and the shipping address is valid.

setAvailableShippingRates

public Storefront.Checkout setAvailableShippingRates(Storefront.AvailableShippingRates arg)

getCompletedAt

public DateTime getCompletedAt()

The date and time when the checkout was completed.

setCompletedAt

public Storefront.Checkout setCompletedAt(DateTime arg)

getCreatedAt

public DateTime getCreatedAt()

The date and time when the checkout was created.

setCreatedAt

public Storefront.Checkout setCreatedAt(DateTime arg)

getCurrencyCode

public Storefront.CurrencyCode getCurrencyCode()

The currency code for the Checkout.

setCurrencyCode

public Storefront.Checkout setCurrencyCode(Storefront.CurrencyCode arg)

getCustomAttributes

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

A list of extra information that is added to the checkout.

setCustomAttributes

public Storefront.Checkout setCustomAttributes(java.util.List<Storefront.Attribute> arg)

getCustomer

public Storefront.Customer getCustomer()

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.

setCustomer

public Storefront.Checkout setCustomer(Storefront.Customer arg)

getDiscountApplications

public Storefront.DiscountApplicationConnection getDiscountApplications()

Discounts that have been applied on the checkout.

setDiscountApplications

public Storefront.Checkout setDiscountApplications(Storefront.DiscountApplicationConnection arg)

getEmail

public java.lang.String getEmail()

The email attached to this checkout.

setEmail

public Storefront.Checkout setEmail(java.lang.String arg)

getId

public ID getId()

Globally unique identifier.

Specified by:

getId in interface Storefront.Node

getLineItems

public Storefront.CheckoutLineItemConnection getLineItems()

A list of line item objects, each one containing information about an item in the checkout.

setLineItems

public Storefront.Checkout setLineItems(Storefront.CheckoutLineItemConnection arg)

getLineItemsSubtotalPrice

public Storefront.MoneyV2 getLineItemsSubtotalPrice()

The sum of all the prices of all the items in the checkout. Duties, taxes, shipping and discounts excluded.

setLineItemsSubtotalPrice

public Storefront.Checkout setLineItemsSubtotalPrice(Storefront.MoneyV2 arg)

getNote

public java.lang.String getNote()

The note associated with the checkout.

setNote

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

getOrder

public Storefront.Order getOrder()

The resulting order from a paid checkout.

setOrder

public Storefront.Checkout setOrder(Storefront.Order arg)

getOrderStatusUrl

public java.lang.String getOrderStatusUrl()

The Order Status Page for this Checkout, null when checkout is not completed.

setOrderStatusUrl

public Storefront.Checkout setOrderStatusUrl(java.lang.String arg)

getPaymentDue

public java.math.BigDecimal getPaymentDue()

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.

setPaymentDue

public Storefront.Checkout setPaymentDue(java.math.BigDecimal arg)

getPaymentDueV2

public Storefront.MoneyV2 getPaymentDueV2()

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.

setPaymentDueV2

public Storefront.Checkout setPaymentDueV2(Storefront.MoneyV2 arg)

getReady

public java.lang.Boolean getReady()

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.

setReady

public Storefront.Checkout setReady(java.lang.Boolean arg)

getRequiresShipping

public java.lang.Boolean getRequiresShipping()

States whether or not the fulfillment requires shipping.

setRequiresShipping

public Storefront.Checkout setRequiresShipping(java.lang.Boolean arg)

getShippingAddress

public Storefront.MailingAddress getShippingAddress()

The shipping address to where the line items will be shipped.

setShippingAddress

public Storefront.Checkout setShippingAddress(Storefront.MailingAddress arg)

getShippingDiscountAllocations

public java.util.List<Storefront.DiscountAllocation> getShippingDiscountAllocations()

The discounts that have been allocated onto the shipping line by discount applications.

setShippingDiscountAllocations

public Storefront.Checkout setShippingDiscountAllocations(java.util.List<Storefront.DiscountAllocation> arg)

getShippingLine

public Storefront.ShippingRate getShippingLine()

Once a shipping rate is selected by the customer it is transitioned to a `shipping_line` object.

setShippingLine

public Storefront.Checkout setShippingLine(Storefront.ShippingRate arg)

getSubtotalPrice

public java.math.BigDecimal getSubtotalPrice()

Deprecated. Use `subtotalPriceV2` instead

Price of the checkout before shipping and taxes.

setSubtotalPrice

public Storefront.Checkout setSubtotalPrice(java.math.BigDecimal arg)

getSubtotalPriceV2

public Storefront.MoneyV2 getSubtotalPriceV2()

Price of the checkout before duties, shipping and taxes.

setSubtotalPriceV2

public Storefront.Checkout setSubtotalPriceV2(Storefront.MoneyV2 arg)

getTaxExempt

public java.lang.Boolean getTaxExempt()

Specifies if the Checkout is tax exempt.

setTaxExempt

public Storefront.Checkout setTaxExempt(java.lang.Boolean arg)

getTaxesIncluded

public java.lang.Boolean getTaxesIncluded()

Specifies if taxes are included in the line item and shipping line prices.

setTaxesIncluded

public Storefront.Checkout setTaxesIncluded(java.lang.Boolean arg)

getTotalDuties

public Storefront.MoneyV2 getTotalDuties()

The sum of all the duties applied to the line items in the checkout.

setTotalDuties

public Storefront.Checkout setTotalDuties(Storefront.MoneyV2 arg)

getTotalPrice

public java.math.BigDecimal getTotalPrice()

Deprecated. Use `totalPriceV2` instead

The sum of all the prices of all the items in the checkout, taxes and discounts included.

setTotalPrice

public Storefront.Checkout setTotalPrice(java.math.BigDecimal arg)

getTotalPriceV2

public Storefront.MoneyV2 getTotalPriceV2()

The sum of all the prices of all the items in the checkout, duties, taxes and discounts included.

setTotalPriceV2

public Storefront.Checkout setTotalPriceV2(Storefront.MoneyV2 arg)

getTotalTax

public java.math.BigDecimal getTotalTax()

Deprecated. Use `totalTaxV2` instead

The sum of all the taxes applied to the line items and shipping lines in the checkout.

setTotalTax

public Storefront.Checkout setTotalTax(java.math.BigDecimal arg)

getTotalTaxV2

public Storefront.MoneyV2 getTotalTaxV2()

The sum of all the taxes applied to the line items and shipping lines in the checkout.

setTotalTaxV2

public Storefront.Checkout setTotalTaxV2(Storefront.MoneyV2 arg)

getUpdatedAt

public DateTime getUpdatedAt()

The date and time when the checkout was last updated.

setUpdatedAt

public Storefront.Checkout setUpdatedAt(DateTime arg)

getWebUrl

public java.lang.String getWebUrl()

The url pointing to the checkout accessible from the web.

setWebUrl

public Storefront.Checkout setWebUrl(java.lang.String arg)

unwrapsToObject

public boolean unwrapsToObject(java.lang.String key)