OBJECT

Checkout

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

GraphQL Schema definition

1 type Checkout implements Node {
2 
3 appliedGiftCards: [AppliedGiftCard!]! 
4 
5 #   The available shipping rates for this Checkout.
6 #   Should only be used when checkout `requiresShipping` is `true` and
7 #   the shipping address is valid.
8 availableShippingRates: AvailableShippingRates 
9 
10 #   The date and time when the checkout was completed.
11 completedAt: DateTime 
12 
13 #   The date and time when the checkout was created.
14 createdAt: DateTime! 
15 
16 #   The currency code for the Checkout.
17 currencyCode: CurrencyCode! 
18 
19 #   A list of extra information that is added to the checkout.
20 customAttributes: [Attribute!]! 
21 
22 #   The customer associated with the checkout.
23 customer: Customer 
24 
25 #   The email attached to this checkout.
26 email: String 
27 
28 id: ID! 
29 
30 #   A list of line item objects, each one containing information about an item in 
31 #   the checkout.
32 lineItems(first: Int!, after: String, reverse: Boolean): CheckoutLineItemConnection! 
33 
34 note: String 
35 
36 #   The resulting order from a paid checkout.
37 order: Order 
38 
39 #   The Order Status Page for this Checkout, null when checkout is not completed.
40 orderStatusUrl: URL 
41 
42 #   The amount left to be paid. This is equal to the cost of the line items, taxes 
43 #   and shipping minus discounts and gift cards.
44 paymentDue: Money! 
45 
46 #   Whether or not the Checkout is ready and can be completed. Checkouts may have 
47 #   asynchronous operations that can take time to finish. If you want to complete a 
48 #   checkout or ensure all the fields are populated and up to date, polling is 
49 #   required until the value is true. 
50 ready: Boolean! 
51 
52 #   States whether or not the fulfillment requires shipping.
53 requiresShipping: Boolean! 
54 
55 #   The shipping address to where the line items will be shipped.
56 shippingAddress: MailingAddress 
57 
58 #   Once a shipping rate is selected by the customer it is transitioned to a 
59 #   `shipping_line` object.
60 shippingLine: ShippingRate 
61 
62 #   Price of the checkout before shipping, taxes, and discounts.
63 subtotalPrice: Money! 
64 
65 #   Specifies if the Checkout is tax exempt.
66 taxExempt: Boolean! 
67 
68 #   Specifies if taxes are included in the line item and shipping line prices.
69 taxesIncluded: Boolean! 
70 
71 #   The sum of all the prices of all the items in the checkout, taxes and discounts 
72 #   included.
73 totalPrice: Money! 
74 
75 #   The sum of all the taxes applied to the line items and shipping lines in the 
76 #   checkout.
77 totalTax: Money! 
78 
79 #   The date and time when the checkout was last updated.
80 updatedAt: DateTime! 
81 
82 #   The url pointing to the checkout accessible from the web.
83 webUrl: URL! 
84 
85 }

1	type Checkout implements Node {
2
3	appliedGiftCards: [AppliedGiftCard!]!
4
5	# The available shipping rates for this Checkout.
6	# Should only be used when checkout `requiresShipping` is `true` and
7	# the shipping address is valid.
8	availableShippingRates: AvailableShippingRates
9
10	# The date and time when the checkout was completed.
11	completedAt: DateTime
12
13	# The date and time when the checkout was created.
14	createdAt: DateTime!
15
16	# The currency code for the Checkout.
17	currencyCode: CurrencyCode!
18
19	# A list of extra information that is added to the checkout.
20	customAttributes: [Attribute!]!
21
22	# The customer associated with the checkout.
23	customer: Customer
24
25	# The email attached to this checkout.
26	email: String
27
28	id: ID!
29
30	# A list of line item objects, each one containing information about an item in
31	# the checkout.
32	lineItems(first: Int!, after: String, reverse: Boolean): CheckoutLineItemConnection!
33
34	note: String
35
36	# The resulting order from a paid checkout.
37	order: Order
38
39	# The Order Status Page for this Checkout, null when checkout is not completed.
40	orderStatusUrl: URL
41
42	# The amount left to be paid. This is equal to the cost of the line items, taxes
43	# and shipping minus discounts and gift cards.
44	paymentDue: Money!
45
46	# Whether or not the Checkout is ready and can be completed. Checkouts may have
47	# asynchronous operations that can take time to finish. If you want to complete a
48	# checkout or ensure all the fields are populated and up to date, polling is
49	# required until the value is true.
50	ready: Boolean!
51
52	# States whether or not the fulfillment requires shipping.
53	requiresShipping: Boolean!
54
55	# The shipping address to where the line items will be shipped.
56	shippingAddress: MailingAddress
57
58	# Once a shipping rate is selected by the customer it is transitioned to a
59	# `shipping_line` object.
60	shippingLine: ShippingRate
61
62	# Price of the checkout before shipping, taxes, and discounts.
63	subtotalPrice: Money!
64
65	# Specifies if the Checkout is tax exempt.
66	taxExempt: Boolean!
67
68	# Specifies if taxes are included in the line item and shipping line prices.
69	taxesIncluded: Boolean!
70
71	# The sum of all the prices of all the items in the checkout, taxes and discounts
72	# included.
73	totalPrice: Money!
74
75	# The sum of all the taxes applied to the line items and shipping lines in the
76	# checkout.
77	totalTax: Money!
78
79	# The date and time when the checkout was last updated.
80	updatedAt: DateTime!
81
82	# The url pointing to the checkout accessible from the web.
83	webUrl: URL!
84
85	}

Checkout

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by