API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

checkoutEmailUpdate mutation

Deprecation warning

Use checkoutEmailUpdateV2 instead

Updates the email on an existing checkout.

Required access

unauthenticated_write_checkouts access scope.

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.


Arguments

Argument Description
checkoutId ( ID! ) required

The ID of the checkout.
email ( String! ) required

The email to update the checkout with.

Return fields

  • checkout (Checkout!)

    The checkout object with the updated email.

  • checkoutUserErrors ([CheckoutUserError!]!)

    List of errors that occurred executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Deprecation warning

Use checkoutEmailUpdateV2 instead

Updates the email on an existing checkout.

Required access

unauthenticated_write_checkouts access scope.

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.


Arguments

Argument Description
checkoutId ( ID! ) required

The ID of the checkout.
email ( String! ) required

The email to update the checkout with.

Return fields

  • checkout (Checkout!)

    The checkout object with the updated email.

  • checkoutUserErrors ([CheckoutUserError!]!)

    List of errors that occurred executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Deprecation warning

Use checkoutEmailUpdateV2 instead

Updates the email on an existing checkout.

Required access

unauthenticated_write_checkouts access scope.

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.


Arguments

Argument Description
checkoutId ( ID! ) required

The ID of the checkout.
email ( String! ) required

The email to update the checkout with.

Return fields

  • checkout (Checkout!)

    The checkout object with the updated email.

  • checkoutUserErrors ([CheckoutUserError!]!)

    List of errors that occurred executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Deprecation warning

Use checkoutEmailUpdateV2 instead

Updates the email on an existing checkout.

Required access

unauthenticated_write_checkouts access scope.

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.


Arguments

Argument Description
checkoutId ( ID! ) required

The ID of the checkout.
email ( String! ) required

The email to update the checkout with.

Return fields

  • checkout (Checkout!)

    The checkout object with the updated email.

  • checkoutUserErrors ([CheckoutUserError!]!)

    List of errors that occurred executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Deprecation warning

Use checkoutEmailUpdateV2 instead

Updates the email on an existing checkout.

Required access

unauthenticated_write_checkouts access scope.

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.


Arguments

Argument Description
checkoutId ( ID! ) required

The ID of the checkout.
email ( String! ) required

The email to update the checkout with.

Return fields

  • checkout (Checkout!)

    The checkout object with the updated email.

  • checkoutUserErrors ([CheckoutUserError!]!)

    List of errors that occurred executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Deprecation warning

Use checkoutEmailUpdateV2 instead

Updates the email on an existing checkout.

Required access

unauthenticated_write_checkouts access scope.

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.


Arguments

Argument Description
checkoutId ( ID! ) required

The ID of the checkout.
email ( String! ) required

The email to update the checkout with.

Return fields

  • checkout (Checkout!)

    The checkout object with the updated email.

  • checkoutUserErrors ([CheckoutUserError!]!)

    List of errors that occurred executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Deprecation warning

Use checkoutEmailUpdateV2 instead

Updates the email on an existing checkout.

Required access

unauthenticated_write_checkouts access scope.

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.


Arguments

Argument Description
checkoutId ( ID! ) required

The ID of the checkout.
email ( String! ) required

The email to update the checkout with.

Return fields

  • checkout (Checkout!)

    The checkout object with the updated email.

  • checkoutUserErrors ([CheckoutUserError!]!)

    List of errors that occurred executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Deprecation warning

Use checkoutEmailUpdateV2 instead

Updates the email on an existing checkout.

Required access

unauthenticated_write_checkouts access scope.

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.


Arguments

Argument Description
checkoutId ( ID! ) required

The ID of the checkout.
email ( String! ) required

The email to update the checkout with.

Return fields

  • checkout (Checkout!)

    The checkout object with the updated email.

  • checkoutUserErrors ([CheckoutUserError!]!)

    List of errors that occurred executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Deprecation warning

Use checkoutEmailUpdateV2 instead

Updates the email on an existing checkout.

Required access

unauthenticated_write_checkouts access scope.

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.


Arguments

Argument Description
checkoutId ( ID! ) required

The ID of the checkout.
email ( String! ) required

The email to update the checkout with.

Return fields

  • checkout (Checkout!)

    The checkout object with the updated email.

  • checkoutUserErrors ([CheckoutUserError!]!)

    List of errors that occurred executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead