Shopify SDK for Unity
Public Member Functions | List of all members
Shopify.Unity.GraphQL.CheckoutQuery Class Reference

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

Public Member Functions

 CheckoutQuery (StringBuilder query)
 CheckoutQuery is used to build queries. Typically CheckoutQuery will not be used directly but instead will be used when building queries from either QueryRootQuery or MutationQuery. More...
 
CheckoutQuery appliedGiftCards (AppliedGiftCardDelegate buildQuery)
 The gift cards used on the checkout. More...
 
CheckoutQuery availableShippingRates (AvailableShippingRatesDelegate buildQuery)
 The available shipping rates for this Checkout. Should only be used when checkout requiresShipping is true and the shipping address is valid. More...
 
CheckoutQuery completedAt ()
 The date and time when the checkout was completed. More...
 
CheckoutQuery createdAt ()
 The date and time when the checkout was created. More...
 
CheckoutQuery currencyCode ()
 The currency code for the Checkout. More...
 
CheckoutQuery customAttributes (AttributeDelegate buildQuery)
 A list of extra information that is added to the checkout. More...
 
CheckoutQuery customer (CustomerDelegate buildQuery)
 The customer associated with the checkout. More...
 
CheckoutQuery discountApplications (DiscountApplicationConnectionDelegate buildQuery, long? first=null, string after=null, long? last=null, string before=null, bool? reverse=null, string alias=null)
 Discounts that have been applied on the checkout. More...
 
CheckoutQuery email ()
 The email attached to this checkout. More...
 
CheckoutQuery id ()
 Globally unique identifier. More...
 
CheckoutQuery lineItems (CheckoutLineItemConnectionDelegate buildQuery, long? first=null, string after=null, long? last=null, string before=null, bool? reverse=null, string alias=null)
 A list of line item objects, each one containing information about an item in the checkout. More...
 
CheckoutQuery lineItemsSubtotalPrice (MoneyV2Delegate buildQuery)
 The sum of all the prices of all the items in the checkout. Duties, taxes, shipping and discounts excluded. More...
 
CheckoutQuery note ()
 The note associated with the checkout. More...
 
CheckoutQuery order (OrderDelegate buildQuery)
 The resulting order from a paid checkout. More...
 
CheckoutQuery orderStatusUrl ()
 The Order Status Page for this Checkout, null when checkout is not completed. More...
 
CheckoutQuery paymentDue ()
 The amount left to be paid. This is equal to the cost of the line items, taxes and shipping minus discounts and gift cards. More...
 
CheckoutQuery paymentDueV2 (MoneyV2Delegate buildQuery)
 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. More...
 
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. More...
 
CheckoutQuery requiresShipping ()
 States whether or not the fulfillment requires shipping. More...
 
CheckoutQuery shippingAddress (MailingAddressDelegate buildQuery)
 The shipping address to where the line items will be shipped. More...
 
CheckoutQuery shippingDiscountAllocations (DiscountAllocationDelegate buildQuery)
 The discounts that have been allocated onto the shipping line by discount applications. More...
 
CheckoutQuery shippingLine (ShippingRateDelegate buildQuery)
 Once a shipping rate is selected by the customer it is transitioned to a shipping_line object. More...
 
CheckoutQuery subtotalPrice ()
 Price of the checkout before shipping and taxes. More...
 
CheckoutQuery subtotalPriceV2 (MoneyV2Delegate buildQuery)
 Price of the checkout before duties, shipping and taxes. More...
 
CheckoutQuery taxExempt ()
 Specifies if the Checkout is tax exempt. More...
 
CheckoutQuery taxesIncluded ()
 Specifies if taxes are included in the line item and shipping line prices. More...
 
CheckoutQuery totalPrice ()
 The sum of all the prices of all the items in the checkout, taxes and discounts included. More...
 
CheckoutQuery totalPriceV2 (MoneyV2Delegate buildQuery)
 The sum of all the prices of all the items in the checkout, duties, taxes and discounts included. More...
 
CheckoutQuery totalTax ()
 The sum of all the taxes applied to the line items and shipping lines in the checkout. More...
 
CheckoutQuery totalTaxV2 (MoneyV2Delegate buildQuery)
 The sum of all the taxes applied to the line items and shipping lines in the checkout. More...
 
CheckoutQuery updatedAt ()
 The date and time when the checkout was last updated. More...
 
CheckoutQuery webUrl ()
 The url pointing to the checkout accessible from the web. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ CheckoutQuery()

Shopify.Unity.GraphQL.CheckoutQuery.CheckoutQuery ( StringBuilder  query)
inline

CheckoutQuery is used to build queries. Typically CheckoutQuery will not be used directly but instead will be used when building queries from either QueryRootQuery or MutationQuery.

Member Function Documentation

◆ appliedGiftCards()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.appliedGiftCards ( AppliedGiftCardDelegate  buildQuery)
inline

The gift cards used on the checkout.

◆ availableShippingRates()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.availableShippingRates ( AvailableShippingRatesDelegate  buildQuery)
inline

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

◆ completedAt()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.completedAt ( )
inline

The date and time when the checkout was completed.

◆ createdAt()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.createdAt ( )
inline

The date and time when the checkout was created.

◆ currencyCode()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.currencyCode ( )
inline

The currency code for the Checkout.

◆ customAttributes()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.customAttributes ( AttributeDelegate  buildQuery)
inline

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

◆ customer()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.customer ( CustomerDelegate  buildQuery)
inline

The customer associated with the checkout.

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.

◆ discountApplications()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.discountApplications ( DiscountApplicationConnectionDelegate  buildQuery,
long?  first = null,
string  after = null,
long?  last = null,
string  before = null,
bool?  reverse = null,
string  alias = null 
)
inline

Discounts that have been applied on the checkout.

Parameters
firstReturns up to the first n elements from the list.
afterReturns the elements that come after the specified cursor.
lastReturns up to the last n elements from the list.
beforeReturns the elements that come before the specified cursor.
reverseReverse the order of the underlying list.

◆ email()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.email ( )
inline

The email attached to this checkout.

◆ id()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.id ( )
inline

Globally unique identifier.

◆ lineItems()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.lineItems ( CheckoutLineItemConnectionDelegate  buildQuery,
long?  first = null,
string  after = null,
long?  last = null,
string  before = null,
bool?  reverse = null,
string  alias = null 
)
inline

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

Parameters
firstReturns up to the first n elements from the list.
afterReturns the elements that come after the specified cursor.
lastReturns up to the last n elements from the list.
beforeReturns the elements that come before the specified cursor.
reverseReverse the order of the underlying list.

◆ lineItemsSubtotalPrice()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.lineItemsSubtotalPrice ( MoneyV2Delegate  buildQuery)
inline

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

◆ note()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.note ( )
inline

The note associated with the checkout.

◆ order()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.order ( OrderDelegate  buildQuery)
inline

The resulting order from a paid checkout.

◆ orderStatusUrl()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.orderStatusUrl ( )
inline

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

◆ paymentDue()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.paymentDue ( )
inline

The amount left to be paid. This is equal to the cost of the line items, taxes and shipping minus discounts and gift cards.

Deprecated:
Use paymentDueV2 instead

◆ paymentDueV2()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.paymentDueV2 ( MoneyV2Delegate  buildQuery)
inline

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

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.ready ( )
inline

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

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.requiresShipping ( )
inline

States whether or not the fulfillment requires shipping.

◆ shippingAddress()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.shippingAddress ( MailingAddressDelegate  buildQuery)
inline

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

◆ shippingDiscountAllocations()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.shippingDiscountAllocations ( DiscountAllocationDelegate  buildQuery)
inline

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

◆ shippingLine()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.shippingLine ( ShippingRateDelegate  buildQuery)
inline

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

◆ subtotalPrice()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.subtotalPrice ( )
inline

Price of the checkout before shipping and taxes.

Deprecated:
Use subtotalPriceV2 instead

◆ subtotalPriceV2()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.subtotalPriceV2 ( MoneyV2Delegate  buildQuery)
inline

Price of the checkout before duties, shipping and taxes.

◆ taxesIncluded()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.taxesIncluded ( )
inline

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

◆ taxExempt()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.taxExempt ( )
inline

Specifies if the Checkout is tax exempt.

◆ totalPrice()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.totalPrice ( )
inline

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

Deprecated:
Use totalPriceV2 instead

◆ totalPriceV2()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.totalPriceV2 ( MoneyV2Delegate  buildQuery)
inline

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

◆ totalTax()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.totalTax ( )
inline

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

Deprecated:
Use totalTaxV2 instead

◆ totalTaxV2()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.totalTaxV2 ( MoneyV2Delegate  buildQuery)
inline

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

◆ updatedAt()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.updatedAt ( )
inline

The date and time when the checkout was last updated.

◆ webUrl()

CheckoutQuery Shopify.Unity.GraphQL.CheckoutQuery.webUrl ( )
inline

The url pointing to the checkout accessible from the web.


The documentation for this class was generated from the following file: