CheckoutCreateInput

Specifies the fields required to create a checkout.

Show definition

# Specifies the fields required to create a checkout.
input CheckoutCreateInput {
  # Allows setting partial addresses on a Checkout, skipping the full validation of attributes.
  # The required attributes are city, province, and country.
  # Full validation of addresses is still done at complete time.
  allowPartialAddresses: Boolean

# A list of extra information that is added to the checkout. customAttributes: [AttributeInput!]

# The email with which the customer wants to checkout. email: String

# A list of line item objects, each one containing information about an item in the checkout. lineItems: [CheckoutLineItemInput!]

# The text of an optional note that a shop owner can attach to the checkout. note: String

# The shipping address to where the line items will be shipped. shippingAddress: MailingAddressInput }

Input Fields

allowPartialAddresses   (Boolean)

Allows setting partial addresses on a Checkout, skipping the full validation of attributes. The required attributes are city, province, and country. Full validation of addresses is still done at complete time.

customAttributes   ([AttributeInput!])

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

email   (String)

The email with which the customer wants to checkout.

lineItems   ([CheckoutLineItemInput!])

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

note   (String)

The text of an optional note that a shop owner can attach to the checkout.

shippingAddress   (MailingAddressInput)

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

Sign up for a Partner account to get started.

Sign up