Anchor to section titled 'undefined'

checkoutEmailUpdateV2
mutation
deprecated

Requires unauthenticated_write_checkouts access scope.

Updates the email on an existing checkout. 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.

Anchor to email
email
String!
required

The email to update the checkout with.

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

CheckoutEmailUpdateV2Payload returns

Anchor to CheckoutEmailUpdateV2Payload.checkout
checkout
Checkout

The checkout object with the updated email.

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

The list of errors that occurred from executing the mutation.

Anchor to CheckoutEmailUpdateV2Payload.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 checkoutEmailUpdateV2($checkoutId: ID!, $email: String!) {
  checkoutEmailUpdateV2(checkoutId: $checkoutId, email: $email) {
    checkout {
      # Checkout fields
    }
    checkoutUserErrors {
      # CheckoutUserError fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "checkoutId": "gid://shopify/<objectName>/10079785100",
  "email": "<your-email>"
}