Skip to main content

CheckoutCreate Object

Create a new checkout.

skipValidation field requires HANDLE_CHECKOUTS and AUTHENTICATED_APP permissions.

Triggers the following webhook events:

  • CHECKOUT_CREATED (async): A checkout was created.
type CheckoutCreate {
  created: Boolean @deprecated
  checkoutErrors: [CheckoutError!]! @deprecated
  errors: [CheckoutError!]!
  checkout: Checkout
}

Fields​

CheckoutCreate.created ● Boolean deprecated scalar miscellaneous​

DEPRECATED

Always returns true.

Whether the checkout was created or the current active one was returned. Refer to checkoutLinesAdd and checkoutLinesUpdate to merge a cart with an active checkout.

CheckoutCreate.checkoutErrors ● [CheckoutError!]! deprecated non-null object checkout​

DEPRECATED

Use errors field instead.

CheckoutCreate.errors ● [CheckoutError!]! non-null object checkout​

CheckoutCreate.checkout ● Checkout object checkout​

Returned By​

checkoutCreate mutation