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

Inheritance diagram for Shopify.Unity.Checkout:

Public Member Functions
	Checkout (Dictionary< string, object > dataJSON)
	Accepts deserialized json data. Will further parse passed in data. More...

List< AppliedGiftCard >	appliedGiftCards ()
	The gift cards used on the checkout. More...

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

DateTime?	completedAt ()
	The date and time when the checkout was completed. More...

DateTime?	createdAt ()
	The date and time when the checkout was created. More...

CurrencyCode	currencyCode ()
	The currency code for the Checkout. More...

List< Attribute >	customAttributes ()
	A list of extra information that is added to the checkout. More...

Customer	customer ()
	The customer associated with the checkout. More...

DiscountApplicationConnection	discountApplications (string alias=null)
	Discounts that have been applied on the checkout. More...

string	email ()
	The email attached to this checkout. More...

string	id ()
	Globally unique identifier. More...

CheckoutLineItemConnection	lineItems (string alias=null)
	A list of line item objects, each one containing information about an item in the checkout. More...

MoneyV2	lineItemsSubtotalPrice ()
	The sum of all the prices of all the items in the checkout. Duties, taxes, shipping and discounts excluded. More...

string	note ()
	The note associated with the checkout. More...

Order	order ()
	The resulting order from a paid checkout. More...

string	orderStatusUrl ()
	The Order Status Page for this Checkout, null when checkout is not completed. More...

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

MoneyV2	paymentDueV2 ()
	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...

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

bool	requiresShipping ()
	States whether or not the fulfillment requires shipping. More...

MailingAddress	shippingAddress ()
	The shipping address to where the line items will be shipped. More...

List< DiscountAllocation >	shippingDiscountAllocations ()
	The discounts that have been allocated onto the shipping line by discount applications. More...

ShippingRate	shippingLine ()
	Once a shipping rate is selected by the customer it is transitioned to a `shipping_line` object. More...

decimal	subtotalPrice ()
	Price of the checkout before shipping and taxes. More...

MoneyV2	subtotalPriceV2 ()
	Price of the checkout before duties, shipping and taxes. More...

bool	taxExempt ()
	Specifies if the Checkout is tax exempt. More...

bool	taxesIncluded ()
	Specifies if taxes are included in the line item and shipping line prices. More...

decimal	totalPrice ()
	The sum of all the prices of all the items in the checkout, taxes and discounts included. More...

MoneyV2	totalPriceV2 ()
	The sum of all the prices of all the items in the checkout, duties, taxes and discounts included. More...

decimal	totalTax ()
	The sum of all the taxes applied to the line items and shipping lines in the checkout. More...

MoneyV2	totalTaxV2 ()
	The sum of all the taxes applied to the line items and shipping lines in the checkout. More...

DateTime?	updatedAt ()
	The date and time when the checkout was last updated. More...

string	webUrl ()
	The url pointing to the checkout accessible from the web. More...

object	Clone ()

Additional Inherited Members
Protected Member Functions inherited from Shopify.Unity.SDK.AbstractResponse
T	Get< T > (string field, string alias=null)

Protected Attributes inherited from Shopify.Unity.SDK.AbstractResponse
Dictionary< string, object >	Data

Properties inherited from Shopify.Unity.SDK.AbstractResponse
Dictionary< string, object >	DataJSON `[get, protected set]`

Detailed Description

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

Constructor & Destructor Documentation

◆ Checkout()

Shopify.Unity.Checkout.Checkout ( Dictionary< string, object > dataJSON )

inline

Accepts deserialized json data. Will further parse passed in data.

Parameters

dataJSON Deserialized JSON data for Checkout

Member Function Documentation

◆ appliedGiftCards()

List<AppliedGiftCard> Shopify.Unity.Checkout.appliedGiftCards ( )

inline

The gift cards used on the checkout.

◆ availableShippingRates()

AvailableShippingRates Shopify.Unity.Checkout.availableShippingRates ( )

inline

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

◆ completedAt()

DateTime? Shopify.Unity.Checkout.completedAt ( )

inline

The date and time when the checkout was completed.

◆ createdAt()

DateTime? Shopify.Unity.Checkout.createdAt ( )

inline

The date and time when the checkout was created.

◆ currencyCode()

CurrencyCode Shopify.Unity.Checkout.currencyCode ( )

inline

The currency code for the Checkout.

◆ customAttributes()

List<Attribute> Shopify.Unity.Checkout.customAttributes ( )

inline

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

◆ customer()

Customer Shopify.Unity.Checkout.customer ( )

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

DiscountApplicationConnection Shopify.Unity.Checkout.discountApplications ( string alias = null )

inline

Discounts that have been applied on the checkout.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ email()

string Shopify.Unity.Checkout.email ( )

inline

The email attached to this checkout.

◆ id()

string Shopify.Unity.Checkout.id ( )

inline

Globally unique identifier.

Implements Shopify.Unity.Node.

◆ lineItems()

CheckoutLineItemConnection Shopify.Unity.Checkout.lineItems ( string alias = null )

inline

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

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ lineItemsSubtotalPrice()

MoneyV2 Shopify.Unity.Checkout.lineItemsSubtotalPrice ( )

inline

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

◆ note()

string Shopify.Unity.Checkout.note ( )

inline

The note associated with the checkout.

◆ order()

Order Shopify.Unity.Checkout.order ( )

inline

The resulting order from a paid checkout.

◆ orderStatusUrl()

string Shopify.Unity.Checkout.orderStatusUrl ( )

inline

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

◆ paymentDue()

decimal Shopify.Unity.Checkout.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()

MoneyV2 Shopify.Unity.Checkout.paymentDueV2 ( )

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

bool Shopify.Unity.Checkout.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()

bool Shopify.Unity.Checkout.requiresShipping ( )

inline

States whether or not the fulfillment requires shipping.

◆ shippingAddress()

MailingAddress Shopify.Unity.Checkout.shippingAddress ( )

inline

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

◆ shippingDiscountAllocations()

List<DiscountAllocation> Shopify.Unity.Checkout.shippingDiscountAllocations ( )

inline

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

◆ shippingLine()

ShippingRate Shopify.Unity.Checkout.shippingLine ( )

inline

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

◆ subtotalPrice()

decimal Shopify.Unity.Checkout.subtotalPrice ( )

inline

Price of the checkout before shipping and taxes.

Deprecated:: Use subtotalPriceV2 instead

◆ subtotalPriceV2()

MoneyV2 Shopify.Unity.Checkout.subtotalPriceV2 ( )

inline

Price of the checkout before duties, shipping and taxes.

◆ taxesIncluded()

bool Shopify.Unity.Checkout.taxesIncluded ( )

inline

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

◆ taxExempt()

bool Shopify.Unity.Checkout.taxExempt ( )

inline

Specifies if the Checkout is tax exempt.

◆ totalPrice()

decimal Shopify.Unity.Checkout.totalPrice ( )

inline

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

Deprecated:: Use totalPriceV2 instead

◆ totalPriceV2()

MoneyV2 Shopify.Unity.Checkout.totalPriceV2 ( )

inline

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

◆ totalTax()

decimal Shopify.Unity.Checkout.totalTax ( )

inline

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

Deprecated:: Use totalTaxV2 instead

◆ totalTaxV2()

MoneyV2 Shopify.Unity.Checkout.totalTaxV2 ( )

inline

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

◆ updatedAt()

DateTime? Shopify.Unity.Checkout.updatedAt ( )

inline

The date and time when the checkout was last updated.

◆ webUrl()

string Shopify.Unity.Checkout.webUrl ( )

inline

The url pointing to the checkout accessible from the web.

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

Assets/Shopify/Unity/Generated/Checkout.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Checkout()

Member Function Documentation

◆ appliedGiftCards()

◆ availableShippingRates()

◆ completedAt()

◆ createdAt()

◆ currencyCode()

◆ customAttributes()

◆ customer()

◆ discountApplications()

◆ email()

◆ id()

◆ lineItems()

◆ lineItemsSubtotalPrice()

◆ note()

◆ order()

◆ orderStatusUrl()

◆ paymentDue()

◆ paymentDueV2()

◆ ready()

◆ requiresShipping()

◆ shippingAddress()

◆ shippingDiscountAllocations()

◆ shippingLine()

◆ subtotalPrice()

◆ subtotalPriceV2()

◆ taxesIncluded()

◆ taxExempt()

◆ totalPrice()

◆ totalPriceV2()

◆ totalTax()

◆ totalTaxV2()

◆ updatedAt()

◆ webUrl()