Anchor to section titled 'undefined'

checkoutCompleteFree
mutation
deprecated

Requires unauthenticated_write_checkouts access scope.

Completes a checkout without providing payment information. You can use this mutation for free items or items whose purchase price is covered by a gift card. The Storefront GraphQL Checkout API is deprecated and will be removed in a future version. Please see https://shopify.dev/changelog/deprecation-of-checkout-apis for more information.

Anchor to section titled 'Arguments'

Arguments

Anchor to checkoutId
checkoutId
ID!
required

The ID of the checkout.

Was this section helpful?
Anchor to section titled 'CheckoutCompleteFreePayload returns'

CheckoutCompleteFreePayload returns

Anchor to CheckoutCompleteFreePayload.checkout
checkout
Checkout

The updated checkout object.

Anchor to CheckoutCompleteFreePayload.checkoutUserErrors
checkoutUserErrors
[CheckoutUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Anchor to CheckoutCompleteFreePayload.userErrors
userErrors
[UserError!]!
non-null
deprecated

The list of errors that occurred from executing the mutation. Use checkoutUserErrors instead.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation checkoutCompleteFree($checkoutId: ID!) {
  checkoutCompleteFree(checkoutId: $checkoutId) {
    checkout {
      # Checkout fields
    }
    checkoutUserErrors {
      # CheckoutUserError fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "checkoutId": "gid://shopify/<objectName>/10079785100"
}