Required access

unauthenticated_write_checkouts access scope

Creates a new checkout.

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Argument Type Default Description
input required CheckoutCreateInput!

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.

Return Fields

checkout   (Checkout)

The new checkout object.

checkoutUserErrors   ([CheckoutUserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields


userErrors   ([UserError!]!)


List of errors that occurred executing the mutation.

Deprecation warning

Use checkoutUserErrors instead

Sign up for a Partner account to get started.

Sign up